diff --git a/docs/dyn/accesscontextmanager_v1.organizations.gcpUserAccessBindings.html b/docs/dyn/accesscontextmanager_v1.organizations.gcpUserAccessBindings.html index ed47284a5f..fe5699020d 100644 --- a/docs/dyn/accesscontextmanager_v1.organizations.gcpUserAccessBindings.html +++ b/docs/dyn/accesscontextmanager_v1.organizations.gcpUserAccessBindings.html @@ -93,7 +93,7 @@

Instance Methods

list_next()

Retrieves the next page of results.

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

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

Updates a GcpUserAccessBinding. Completion of this long-running operation does not necessarily signify that the changed binding is deployed onto all affected users, which may take more time.

Method Details

@@ -110,7 +110,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Restricts access to Cloud Console and Google Cloud APIs for a set of users using Context-Aware Access. +{ # Restricts access to Cloud Console and Google Cloud APIs for a set of users using Context-Aware Access. Next ID: 11 "accessLevels": [ # Optional. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" "A String", ], @@ -145,6 +145,13 @@

Method Details

"sessionLengthEnabled": True or False, # Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite. "useOidcMaxAge": True or False, # Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param. }, + "sessionSettings": { # Stores settings related to Google Cloud Session Length including session duration, the type of challenge (i.e. method) they should face when their session expires, and other related settings. # Optional. Session settings applied to user access on a given AccessScope. Migrated from ReauthSettings + "maxInactivity": "A String", # Optional. How long a user is allowed to take between actions before a new access token must be issued. Presently only set for Cloud Apps. + "sessionLength": "A String", # Optional. The session length. Setting this field to zero is equal to disabling. Session. Also can set infinite session by flipping the enabled bit to false below. If use_oidc_max_age is true, for OIDC apps, the session length will be the minimum of this field and OIDC max_age param. + "sessionLengthEnabled": True or False, # Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite. + "sessionReauthMethod": "A String", # Optional. Session method when users GCP session is up. + "useOidcMaxAge": True or False, # Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param. + }, }, "dryRunSettings": { # Access settings represent the set of conditions that must be met for access to be granted. At least one of the fields must be set. # Optional. Dry-run access settings for this scoped access settings. This field may be empty if active_settings is set. "accessLevels": [ # Optional. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" @@ -157,6 +164,13 @@

Method Details

"sessionLengthEnabled": True or False, # Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite. "useOidcMaxAge": True or False, # Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param. }, + "sessionSettings": { # Stores settings related to Google Cloud Session Length including session duration, the type of challenge (i.e. method) they should face when their session expires, and other related settings. # Optional. Session settings applied to user access on a given AccessScope. Migrated from ReauthSettings + "maxInactivity": "A String", # Optional. How long a user is allowed to take between actions before a new access token must be issued. Presently only set for Cloud Apps. + "sessionLength": "A String", # Optional. The session length. Setting this field to zero is equal to disabling. Session. Also can set infinite session by flipping the enabled bit to false below. If use_oidc_max_age is true, for OIDC apps, the session length will be the minimum of this field and OIDC max_age param. + "sessionLengthEnabled": True or False, # Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite. + "sessionReauthMethod": "A String", # Optional. Session method when users GCP session is up. + "useOidcMaxAge": True or False, # Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param. + }, }, "scope": { # Access scope represents the client scope, etc. to which the settings will be applied to. # Optional. Application, etc. to which the access settings will be applied to. Implicitly, this is the scoped access settings key; as such, it must be unique and non-empty. "clientScope": { # Client scope represents the application, etc. subject to this binding's restrictions. # Optional. Client scope for this access scope. @@ -248,7 +262,7 @@

Method Details

Returns: An object of the form: - { # Restricts access to Cloud Console and Google Cloud APIs for a set of users using Context-Aware Access. + { # Restricts access to Cloud Console and Google Cloud APIs for a set of users using Context-Aware Access. Next ID: 11 "accessLevels": [ # Optional. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" "A String", ], @@ -283,6 +297,13 @@

Method Details

"sessionLengthEnabled": True or False, # Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite. "useOidcMaxAge": True or False, # Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param. }, + "sessionSettings": { # Stores settings related to Google Cloud Session Length including session duration, the type of challenge (i.e. method) they should face when their session expires, and other related settings. # Optional. Session settings applied to user access on a given AccessScope. Migrated from ReauthSettings + "maxInactivity": "A String", # Optional. How long a user is allowed to take between actions before a new access token must be issued. Presently only set for Cloud Apps. + "sessionLength": "A String", # Optional. The session length. Setting this field to zero is equal to disabling. Session. Also can set infinite session by flipping the enabled bit to false below. If use_oidc_max_age is true, for OIDC apps, the session length will be the minimum of this field and OIDC max_age param. + "sessionLengthEnabled": True or False, # Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite. + "sessionReauthMethod": "A String", # Optional. Session method when users GCP session is up. + "useOidcMaxAge": True or False, # Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param. + }, }, "dryRunSettings": { # Access settings represent the set of conditions that must be met for access to be granted. At least one of the fields must be set. # Optional. Dry-run access settings for this scoped access settings. This field may be empty if active_settings is set. "accessLevels": [ # Optional. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" @@ -295,6 +316,13 @@

Method Details

"sessionLengthEnabled": True or False, # Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite. "useOidcMaxAge": True or False, # Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param. }, + "sessionSettings": { # Stores settings related to Google Cloud Session Length including session duration, the type of challenge (i.e. method) they should face when their session expires, and other related settings. # Optional. Session settings applied to user access on a given AccessScope. Migrated from ReauthSettings + "maxInactivity": "A String", # Optional. How long a user is allowed to take between actions before a new access token must be issued. Presently only set for Cloud Apps. + "sessionLength": "A String", # Optional. The session length. Setting this field to zero is equal to disabling. Session. Also can set infinite session by flipping the enabled bit to false below. If use_oidc_max_age is true, for OIDC apps, the session length will be the minimum of this field and OIDC max_age param. + "sessionLengthEnabled": True or False, # Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite. + "sessionReauthMethod": "A String", # Optional. Session method when users GCP session is up. + "useOidcMaxAge": True or False, # Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param. + }, }, "scope": { # Access scope represents the client scope, etc. to which the settings will be applied to. # Optional. Application, etc. to which the access settings will be applied to. Implicitly, this is the scoped access settings key; as such, it must be unique and non-empty. "clientScope": { # Client scope represents the application, etc. subject to this binding's restrictions. # Optional. Client scope for this access scope. @@ -327,7 +355,7 @@

Method Details

{ # Response of ListGcpUserAccessBindings. "gcpUserAccessBindings": [ # GcpUserAccessBinding - { # Restricts access to Cloud Console and Google Cloud APIs for a set of users using Context-Aware Access. + { # Restricts access to Cloud Console and Google Cloud APIs for a set of users using Context-Aware Access. Next ID: 11 "accessLevels": [ # Optional. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" "A String", ], @@ -362,6 +390,13 @@

Method Details

"sessionLengthEnabled": True or False, # Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite. "useOidcMaxAge": True or False, # Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param. }, + "sessionSettings": { # Stores settings related to Google Cloud Session Length including session duration, the type of challenge (i.e. method) they should face when their session expires, and other related settings. # Optional. Session settings applied to user access on a given AccessScope. Migrated from ReauthSettings + "maxInactivity": "A String", # Optional. How long a user is allowed to take between actions before a new access token must be issued. Presently only set for Cloud Apps. + "sessionLength": "A String", # Optional. The session length. Setting this field to zero is equal to disabling. Session. Also can set infinite session by flipping the enabled bit to false below. If use_oidc_max_age is true, for OIDC apps, the session length will be the minimum of this field and OIDC max_age param. + "sessionLengthEnabled": True or False, # Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite. + "sessionReauthMethod": "A String", # Optional. Session method when users GCP session is up. + "useOidcMaxAge": True or False, # Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param. + }, }, "dryRunSettings": { # Access settings represent the set of conditions that must be met for access to be granted. At least one of the fields must be set. # Optional. Dry-run access settings for this scoped access settings. This field may be empty if active_settings is set. "accessLevels": [ # Optional. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" @@ -374,6 +409,13 @@

Method Details

"sessionLengthEnabled": True or False, # Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite. "useOidcMaxAge": True or False, # Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param. }, + "sessionSettings": { # Stores settings related to Google Cloud Session Length including session duration, the type of challenge (i.e. method) they should face when their session expires, and other related settings. # Optional. Session settings applied to user access on a given AccessScope. Migrated from ReauthSettings + "maxInactivity": "A String", # Optional. How long a user is allowed to take between actions before a new access token must be issued. Presently only set for Cloud Apps. + "sessionLength": "A String", # Optional. The session length. Setting this field to zero is equal to disabling. Session. Also can set infinite session by flipping the enabled bit to false below. If use_oidc_max_age is true, for OIDC apps, the session length will be the minimum of this field and OIDC max_age param. + "sessionLengthEnabled": True or False, # Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite. + "sessionReauthMethod": "A String", # Optional. Session method when users GCP session is up. + "useOidcMaxAge": True or False, # Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param. + }, }, "scope": { # Access scope represents the client scope, etc. to which the settings will be applied to. # Optional. Application, etc. to which the access settings will be applied to. Implicitly, this is the scoped access settings key; as such, it must be unique and non-empty. "clientScope": { # Client scope represents the application, etc. subject to this binding's restrictions. # Optional. Client scope for this access scope. @@ -406,7 +448,7 @@

Method Details

- patch(name, appendScopedAccessSettings=None, body=None, updateMask=None, x__xgafv=None) + patch(name, append=None, body=None, updateMask=None, x__xgafv=None)
Updates a GcpUserAccessBinding. Completion of this long-running operation does not necessarily signify that the changed binding is deployed onto all affected users, which may take more time.
 
 Args:
@@ -414,7 +456,7 @@ 

Method Details

body: object, The request body. The object takes the form of: -{ # Restricts access to Cloud Console and Google Cloud APIs for a set of users using Context-Aware Access. +{ # Restricts access to Cloud Console and Google Cloud APIs for a set of users using Context-Aware Access. Next ID: 11 "accessLevels": [ # Optional. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" "A String", ], @@ -449,6 +491,13 @@

Method Details

"sessionLengthEnabled": True or False, # Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite. "useOidcMaxAge": True or False, # Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param. }, + "sessionSettings": { # Stores settings related to Google Cloud Session Length including session duration, the type of challenge (i.e. method) they should face when their session expires, and other related settings. # Optional. Session settings applied to user access on a given AccessScope. Migrated from ReauthSettings + "maxInactivity": "A String", # Optional. How long a user is allowed to take between actions before a new access token must be issued. Presently only set for Cloud Apps. + "sessionLength": "A String", # Optional. The session length. Setting this field to zero is equal to disabling. Session. Also can set infinite session by flipping the enabled bit to false below. If use_oidc_max_age is true, for OIDC apps, the session length will be the minimum of this field and OIDC max_age param. + "sessionLengthEnabled": True or False, # Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite. + "sessionReauthMethod": "A String", # Optional. Session method when users GCP session is up. + "useOidcMaxAge": True or False, # Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param. + }, }, "dryRunSettings": { # Access settings represent the set of conditions that must be met for access to be granted. At least one of the fields must be set. # Optional. Dry-run access settings for this scoped access settings. This field may be empty if active_settings is set. "accessLevels": [ # Optional. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" @@ -461,6 +510,13 @@

Method Details

"sessionLengthEnabled": True or False, # Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite. "useOidcMaxAge": True or False, # Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param. }, + "sessionSettings": { # Stores settings related to Google Cloud Session Length including session duration, the type of challenge (i.e. method) they should face when their session expires, and other related settings. # Optional. Session settings applied to user access on a given AccessScope. Migrated from ReauthSettings + "maxInactivity": "A String", # Optional. How long a user is allowed to take between actions before a new access token must be issued. Presently only set for Cloud Apps. + "sessionLength": "A String", # Optional. The session length. Setting this field to zero is equal to disabling. Session. Also can set infinite session by flipping the enabled bit to false below. If use_oidc_max_age is true, for OIDC apps, the session length will be the minimum of this field and OIDC max_age param. + "sessionLengthEnabled": True or False, # Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite. + "sessionReauthMethod": "A String", # Optional. Session method when users GCP session is up. + "useOidcMaxAge": True or False, # Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param. + }, }, "scope": { # Access scope represents the client scope, etc. to which the settings will be applied to. # Optional. Application, etc. to which the access settings will be applied to. Implicitly, this is the scoped access settings key; as such, it must be unique and non-empty. "clientScope": { # Client scope represents the application, etc. subject to this binding's restrictions. # Optional. Client scope for this access scope. @@ -474,8 +530,8 @@

Method Details

], } - appendScopedAccessSettings: boolean, Optional. This field will be used to control whether or not scoped access settings are appended to the existing list of scoped access settings. If true, the scoped access settings in the request will be appended to the existing list of scoped access settings. If false, the scoped access settings in the request replace the existing list of scoped access settings. - updateMask: string, Required. Only the fields specified in this mask are updated. Because name and group_key cannot be changed, update_mask is required and may only contain the following fields: `access_levels`, `dry_run_access_levels`, `reauth_settings`, `scoped_access_settings`. update_mask { paths: "access_levels" } + append: boolean, Optional. This field controls whether or not certain repeated settings in the update request overwrite or append to existing settings on the binding. If true, then append. Otherwise overwrite. So far, only scoped_access_settings supports appending. Global access_levels, dry_run_access_levels, reauth_settings, and session_settings are not compatible with append functionality, and the request will return an error if append=true when these settings are in the update_mask. The request will also return an error if append=true when "scoped_access_settings" is not set in the update_mask. + updateMask: string, Required. Only the fields specified in this mask are updated. Because name and group_key cannot be changed, update_mask is required and may only contain the following fields: `access_levels`, `dry_run_access_levels`, `reauth_settings` `session_settings`, `scoped_access_settings`. update_mask { paths: "access_levels" } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html index 6f513b9d3c..dda9ec2055 100644 --- a/docs/dyn/aiplatform_v1.endpoints.html +++ b/docs/dyn/aiplatform_v1.endpoints.html @@ -213,6 +213,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -226,7 +227,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -318,7 +319,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -352,7 +353,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -472,6 +473,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -485,7 +487,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -591,7 +593,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -625,7 +627,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -889,6 +891,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -902,7 +905,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1008,7 +1011,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1042,7 +1045,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. diff --git a/docs/dyn/aiplatform_v1.projects.locations.customJobs.html b/docs/dyn/aiplatform_v1.projects.locations.customJobs.html index 83c11d6f09..25f9ae5f3b 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.customJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.customJobs.html @@ -169,6 +169,8 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -294,6 +296,8 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -461,6 +465,8 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -599,6 +605,8 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index 785b5f1054..3de4931bbe 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -271,6 +271,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -284,7 +285,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -376,7 +377,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -410,7 +411,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1357,6 +1358,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -1370,7 +1372,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1476,7 +1478,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1510,7 +1512,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -3087,6 +3089,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -3100,7 +3103,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -3206,7 +3209,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -3240,7 +3243,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureGroups.features.html b/docs/dyn/aiplatform_v1.projects.locations.featureGroups.features.html index bb7c563965..4587867533 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featureGroups.features.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featureGroups.features.html @@ -79,6 +79,9 @@

Instance Methods

Returns the operations Resource.

+

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

+

Creates a batch of Features in a given FeatureGroup.

close()

Close httplib2 connections.

@@ -101,6 +104,81 @@

Instance Methods

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

Updates the parameters of a single Feature.

Method Details

+
+ batchCreate(parent, body=None, x__xgafv=None) +
Creates a batch of Features in a given FeatureGroup.
+
+Args:
+  parent: string, Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for FeaturestoreService.BatchCreateFeatures. Request message for FeatureRegistryService.BatchCreateFeatures.
+  "requests": [ # Required. The request message specifying the Features to create. All Features must be created under the same parent EntityType / FeatureGroup. The `parent` field in each child request message can be omitted. If `parent` is set in a child request, then the value must match the `parent` value in this request message.
+    { # Request message for FeaturestoreService.CreateFeature. Request message for FeatureRegistryService.CreateFeature.
+      "feature": { # Feature Metadata information. For example, color is a feature that describes an apple. # Required. The Feature to create.
+        "createTime": "A String", # Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was created.
+        "description": "A String", # Description of the Feature.
+        "disableMonitoring": True or False, # Optional. Only applicable for Vertex AI Feature Store (Legacy). If not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 can enable monitoring. If set to true, all types of data monitoring are disabled despite the config on EntityType.
+        "etag": "A String", # Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
+        "labels": { # Optional. The labels with user-defined metadata to organize your Features. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one Feature (System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
+          "a_key": "A String",
+        },
+        "monitoringStatsAnomalies": [ # Output only. Only applicable for Vertex AI Feature Store (Legacy). The list of historical stats and anomalies with specified objectives.
+          { # A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending.
+            "featureStatsAnomaly": { # Stats and Anomaly generated at specific timestamp for specific Feature. The start_time and end_time are used to define the time range of the dataset that current stats belongs to, e.g. prediction traffic is bucketed into prediction datasets by time window. If the Dataset is not defined by time window, start_time = end_time. Timestamp of the stats and anomalies always refers to end_time. Raw stats and anomalies are stored in stats_uri or anomaly_uri in the tensorflow defined protos. Field data_stats contains almost identical information with the raw stats in Vertex AI defined proto, for UI to display. # Output only. The stats and anomalies generated at specific timestamp.
+              "anomalyDetectionThreshold": 3.14, # This is the threshold used when detecting anomalies. The threshold can be changed by user, so this one might be different from ThresholdConfig.value.
+              "anomalyUri": "A String", # Path of the anomaly file for current feature values in Cloud Storage bucket. Format: gs:////anomalies. Example: gs://monitoring_bucket/feature_name/anomalies. Stats are stored as binary format with Protobuf message Anoamlies are stored as binary format with Protobuf message [tensorflow.metadata.v0.AnomalyInfo] (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto).
+              "distributionDeviation": 3.14, # Deviation from the current stats to baseline stats. 1. For categorical feature, the distribution distance is calculated by L-inifinity norm. 2. For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence.
+              "endTime": "A String", # The end timestamp of window where stats were generated. For objectives where time window doesn't make sense (e.g. Featurestore Snapshot Monitoring), end_time indicates the timestamp of the data used to generate stats (e.g. timestamp we take snapshots for feature values).
+              "score": 3.14, # Feature importance score, only populated when cross-feature monitoring is enabled. For now only used to represent feature attribution score within range [0, 1] for ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW and ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT.
+              "startTime": "A String", # The start timestamp of window where stats were generated. For objectives where time window doesn't make sense (e.g. Featurestore Snapshot Monitoring), start_time is only used to indicate the monitoring intervals, so it always equals to (end_time - monitoring_interval).
+              "statsUri": "A String", # Path of the stats file for current feature values in Cloud Storage bucket. Format: gs:////stats. Example: gs://monitoring_bucket/feature_name/stats. Stats are stored as binary format with Protobuf message [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto).
+            },
+            "objective": "A String", # Output only. The objective for each stats.
+          },
+        ],
+        "name": "A String", # Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.
+        "pointOfContact": "A String", # Entity responsible for maintaining this feature. Can be comma separated list of email addresses or URIs.
+        "updateTime": "A String", # Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was most recently updated.
+        "valueType": "A String", # Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value.
+        "versionColumnName": "A String", # Only applicable for Vertex AI Feature Store. The name of the BigQuery Table/View column hosting data for this version. If no value is provided, will use feature_id.
+      },
+      "featureId": "A String", # Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.
+      "parent": "A String", # Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html index 4e164c0d79..2691f612b5 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html @@ -179,6 +179,7 @@

Method Details

"satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "syncConfig": { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. + "continuous": True or False, # Optional. If true, syncs the FeatureView in a continuous manner to Online Store. "cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". }, "updateTime": "A String", # Output only. Timestamp when this FeatureView was last updated. @@ -398,6 +399,7 @@

Method Details

"satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "syncConfig": { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. + "continuous": True or False, # Optional. If true, syncs the FeatureView in a continuous manner to Online Store. "cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". }, "updateTime": "A String", # Output only. Timestamp when this FeatureView was last updated. @@ -504,6 +506,7 @@

Method Details

"satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "syncConfig": { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. + "continuous": True or False, # Optional. If true, syncs the FeatureView in a continuous manner to Online Store. "cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". }, "updateTime": "A String", # Output only. Timestamp when this FeatureView was last updated. @@ -581,6 +584,7 @@

Method Details

"satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "syncConfig": { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. + "continuous": True or False, # Optional. If true, syncs the FeatureView in a continuous manner to Online Store. "cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". }, "updateTime": "A String", # Output only. Timestamp when this FeatureView was last updated. diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index 868316b9dc..ac5b95c38e 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -495,7 +495,7 @@

Method Details

}, ], "metricSpec": { # Spec for tool parameter key value match metric. # Required. Spec for tool parameter key value match metric. - "useStrictStringMatch": True or False, # Optional. Whether to use STRCIT string match on parameter values. + "useStrictStringMatch": True or False, # Optional. Whether to use STRICT string match on parameter values. }, }, } diff --git a/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html index e8bec69801..d869d3aaf5 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html @@ -272,6 +272,8 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -532,6 +534,8 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -834,6 +838,8 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -1107,6 +1113,8 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html b/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html index c0e6fa28ff..93e48fd40b 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html @@ -225,6 +225,8 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -316,6 +318,8 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -495,6 +499,8 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -586,6 +592,8 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -807,6 +815,8 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -898,6 +908,8 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -1090,6 +1102,8 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -1181,6 +1195,8 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index 1882019962..23e3f3ca69 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -225,6 +225,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -238,7 +239,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -330,7 +331,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -364,7 +365,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -484,6 +485,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -497,7 +499,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -603,7 +605,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -637,7 +639,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1165,6 +1167,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -1178,7 +1181,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1284,7 +1287,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1318,7 +1321,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index 9e037d03b6..872cda658c 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -216,6 +216,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -229,7 +230,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -321,7 +322,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -355,7 +356,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -475,6 +476,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -488,7 +490,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -594,7 +596,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -628,7 +630,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1285,6 +1287,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -1298,7 +1301,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1404,7 +1407,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1438,7 +1441,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index ec6dd600fe..1325020fa6 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -213,6 +213,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -226,7 +227,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -318,7 +319,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -352,7 +353,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -473,6 +474,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -486,7 +488,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -592,7 +594,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -626,7 +628,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -895,6 +897,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -908,7 +911,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1014,7 +1017,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1048,7 +1051,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index 786e44df5f..9c15e089de 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -202,7 +202,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -236,7 +236,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -406,7 +406,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -440,7 +440,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -635,7 +635,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -669,7 +669,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -850,7 +850,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -884,7 +884,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1073,7 +1073,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1107,7 +1107,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1278,7 +1278,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1312,7 +1312,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html index 6e6948d250..b2b036e047 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html @@ -169,6 +169,9 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -294,6 +297,9 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -461,6 +467,9 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -599,6 +608,9 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 4f8e0690bf..e3e90b128f 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -280,6 +280,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -293,7 +294,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -385,7 +386,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -419,7 +420,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1506,6 +1507,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -1519,7 +1521,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1625,7 +1627,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1659,7 +1661,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -3362,6 +3364,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -3375,7 +3378,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -3481,7 +3484,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -3515,7 +3518,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html index f96edb2200..188d9cc8f4 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html @@ -228,7 +228,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -262,7 +262,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -388,7 +388,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -422,7 +422,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -587,7 +587,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -621,7 +621,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -764,7 +764,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -798,7 +798,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -923,7 +923,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -957,7 +957,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.features.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.features.html index aca2a12ec9..cc4e79f396 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.features.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.features.html @@ -79,6 +79,9 @@

Instance Methods

Returns the operations Resource.

+

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

+

Creates a batch of Features in a given FeatureGroup.

close()

Close httplib2 connections.

@@ -101,6 +104,110 @@

Instance Methods

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

Updates the parameters of a single Feature.

Method Details

+
+ batchCreate(parent, body=None, x__xgafv=None) +
Creates a batch of Features in a given FeatureGroup.
+
+Args:
+  parent: string, Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for FeaturestoreService.BatchCreateFeatures. Request message for FeatureRegistryService.BatchCreateFeatures.
+  "requests": [ # Required. The request message specifying the Features to create. All Features must be created under the same parent EntityType / FeatureGroup. The `parent` field in each child request message can be omitted. If `parent` is set in a child request, then the value must match the `parent` value in this request message.
+    { # Request message for FeaturestoreService.CreateFeature. Request message for FeatureRegistryService.CreateFeature.
+      "feature": { # Feature Metadata information. For example, color is a feature that describes an apple. # Required. The Feature to create.
+        "createTime": "A String", # Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was created.
+        "description": "A String", # Description of the Feature.
+        "disableMonitoring": True or False, # Optional. Only applicable for Vertex AI Feature Store (Legacy). If not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 can enable monitoring. If set to true, all types of data monitoring are disabled despite the config on EntityType.
+        "etag": "A String", # Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
+        "labels": { # Optional. The labels with user-defined metadata to organize your Features. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one Feature (System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
+          "a_key": "A String",
+        },
+        "monitoringConfig": { # Configuration of how features in Featurestore are monitored. # Optional. Only applicable for Vertex AI Feature Store (Legacy). Deprecated: The custom monitoring configuration for this Feature, if not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 can enable monitoring. If this is populated with FeaturestoreMonitoringConfig.disabled = true, snapshot analysis monitoring is disabled; if FeaturestoreMonitoringConfig.monitoring_interval specified, snapshot analysis monitoring is enabled. Otherwise, snapshot analysis monitoring config is same as the EntityType's this Feature belongs to.
+          "categoricalThresholdConfig": { # The config for Featurestore Monitoring threshold. # Threshold for categorical features of anomaly detection. This is shared by all types of Featurestore Monitoring for categorical features (i.e. Features with type (Feature.ValueType) BOOL or STRING).
+            "value": 3.14, # Specify a threshold value that can trigger the alert. 1. For categorical feature, the distribution distance is calculated by L-inifinity norm. 2. For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence. Each feature must have a non-zero threshold if they need to be monitored. Otherwise no alert will be triggered for that feature.
+          },
+          "importFeaturesAnalysis": { # Configuration of the Featurestore's ImportFeature Analysis Based Monitoring. This type of analysis generates statistics for values of each Feature imported by every ImportFeatureValues operation. # The config for ImportFeatures Analysis Based Feature Monitoring.
+            "anomalyDetectionBaseline": "A String", # The baseline used to do anomaly detection for the statistics generated by import features analysis.
+            "state": "A String", # Whether to enable / disable / inherite default hebavior for import features analysis.
+          },
+          "numericalThresholdConfig": { # The config for Featurestore Monitoring threshold. # Threshold for numerical features of anomaly detection. This is shared by all objectives of Featurestore Monitoring for numerical features (i.e. Features with type (Feature.ValueType) DOUBLE or INT64).
+            "value": 3.14, # Specify a threshold value that can trigger the alert. 1. For categorical feature, the distribution distance is calculated by L-inifinity norm. 2. For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence. Each feature must have a non-zero threshold if they need to be monitored. Otherwise no alert will be triggered for that feature.
+          },
+          "snapshotAnalysis": { # Configuration of the Featurestore's Snapshot Analysis Based Monitoring. This type of analysis generates statistics for each Feature based on a snapshot of the latest feature value of each entities every monitoring_interval. # The config for Snapshot Analysis Based Feature Monitoring.
+            "disabled": True or False, # The monitoring schedule for snapshot analysis. For EntityType-level config: unset / disabled = true indicates disabled by default for Features under it; otherwise by default enable snapshot analysis monitoring with monitoring_interval for Features under it. Feature-level config: disabled = true indicates disabled regardless of the EntityType-level config; unset monitoring_interval indicates going with EntityType-level config; otherwise run snapshot analysis monitoring with monitoring_interval regardless of the EntityType-level config. Explicitly Disable the snapshot analysis based monitoring.
+            "monitoringInterval": "A String", # Configuration of the snapshot analysis based monitoring pipeline running interval. The value is rolled up to full day. If both monitoring_interval_days and the deprecated `monitoring_interval` field are set when creating/updating EntityTypes/Features, monitoring_interval_days will be used.
+            "monitoringIntervalDays": 42, # Configuration of the snapshot analysis based monitoring pipeline running interval. The value indicates number of days.
+            "stalenessDays": 42, # Customized export features time window for snapshot analysis. Unit is one day. Default value is 3 weeks. Minimum value is 1 day. Maximum value is 4000 days.
+          },
+        },
+        "monitoringStats": [ # Output only. Only applicable for Vertex AI Feature Store (Legacy). A list of historical SnapshotAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending.
+          { # Stats and Anomaly generated at specific timestamp for specific Feature. The start_time and end_time are used to define the time range of the dataset that current stats belongs to, e.g. prediction traffic is bucketed into prediction datasets by time window. If the Dataset is not defined by time window, start_time = end_time. Timestamp of the stats and anomalies always refers to end_time. Raw stats and anomalies are stored in stats_uri or anomaly_uri in the tensorflow defined protos. Field data_stats contains almost identical information with the raw stats in Vertex AI defined proto, for UI to display.
+            "anomalyDetectionThreshold": 3.14, # This is the threshold used when detecting anomalies. The threshold can be changed by user, so this one might be different from ThresholdConfig.value.
+            "anomalyUri": "A String", # Path of the anomaly file for current feature values in Cloud Storage bucket. Format: gs:////anomalies. Example: gs://monitoring_bucket/feature_name/anomalies. Stats are stored as binary format with Protobuf message Anoamlies are stored as binary format with Protobuf message [tensorflow.metadata.v0.AnomalyInfo] (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto).
+            "distributionDeviation": 3.14, # Deviation from the current stats to baseline stats. 1. For categorical feature, the distribution distance is calculated by L-inifinity norm. 2. For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence.
+            "endTime": "A String", # The end timestamp of window where stats were generated. For objectives where time window doesn't make sense (e.g. Featurestore Snapshot Monitoring), end_time indicates the timestamp of the data used to generate stats (e.g. timestamp we take snapshots for feature values).
+            "score": 3.14, # Feature importance score, only populated when cross-feature monitoring is enabled. For now only used to represent feature attribution score within range [0, 1] for ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW and ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT.
+            "startTime": "A String", # The start timestamp of window where stats were generated. For objectives where time window doesn't make sense (e.g. Featurestore Snapshot Monitoring), start_time is only used to indicate the monitoring intervals, so it always equals to (end_time - monitoring_interval).
+            "statsUri": "A String", # Path of the stats file for current feature values in Cloud Storage bucket. Format: gs:////stats. Example: gs://monitoring_bucket/feature_name/stats. Stats are stored as binary format with Protobuf message [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto).
+          },
+        ],
+        "monitoringStatsAnomalies": [ # Output only. Only applicable for Vertex AI Feature Store (Legacy). The list of historical stats and anomalies with specified objectives.
+          { # A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending.
+            "featureStatsAnomaly": { # Stats and Anomaly generated at specific timestamp for specific Feature. The start_time and end_time are used to define the time range of the dataset that current stats belongs to, e.g. prediction traffic is bucketed into prediction datasets by time window. If the Dataset is not defined by time window, start_time = end_time. Timestamp of the stats and anomalies always refers to end_time. Raw stats and anomalies are stored in stats_uri or anomaly_uri in the tensorflow defined protos. Field data_stats contains almost identical information with the raw stats in Vertex AI defined proto, for UI to display. # Output only. The stats and anomalies generated at specific timestamp.
+              "anomalyDetectionThreshold": 3.14, # This is the threshold used when detecting anomalies. The threshold can be changed by user, so this one might be different from ThresholdConfig.value.
+              "anomalyUri": "A String", # Path of the anomaly file for current feature values in Cloud Storage bucket. Format: gs:////anomalies. Example: gs://monitoring_bucket/feature_name/anomalies. Stats are stored as binary format with Protobuf message Anoamlies are stored as binary format with Protobuf message [tensorflow.metadata.v0.AnomalyInfo] (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto).
+              "distributionDeviation": 3.14, # Deviation from the current stats to baseline stats. 1. For categorical feature, the distribution distance is calculated by L-inifinity norm. 2. For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence.
+              "endTime": "A String", # The end timestamp of window where stats were generated. For objectives where time window doesn't make sense (e.g. Featurestore Snapshot Monitoring), end_time indicates the timestamp of the data used to generate stats (e.g. timestamp we take snapshots for feature values).
+              "score": 3.14, # Feature importance score, only populated when cross-feature monitoring is enabled. For now only used to represent feature attribution score within range [0, 1] for ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW and ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT.
+              "startTime": "A String", # The start timestamp of window where stats were generated. For objectives where time window doesn't make sense (e.g. Featurestore Snapshot Monitoring), start_time is only used to indicate the monitoring intervals, so it always equals to (end_time - monitoring_interval).
+              "statsUri": "A String", # Path of the stats file for current feature values in Cloud Storage bucket. Format: gs:////stats. Example: gs://monitoring_bucket/feature_name/stats. Stats are stored as binary format with Protobuf message [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto).
+            },
+            "objective": "A String", # Output only. The objective for each stats.
+          },
+        ],
+        "name": "A String", # Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.
+        "pointOfContact": "A String", # Entity responsible for maintaining this feature. Can be comma separated list of email addresses or URIs.
+        "updateTime": "A String", # Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was most recently updated.
+        "valueType": "A String", # Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value.
+        "versionColumnName": "A String", # Only applicable for Vertex AI Feature Store. The name of the BigQuery Table/View column hosting data for this version. If no value is provided, will use feature_id.
+      },
+      "featureId": "A String", # Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.
+      "parent": "A String", # Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html index db6778f21d..642ced6f43 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html @@ -190,6 +190,7 @@

Method Details

"serviceAccountEmail": "A String", # Output only. A Service Account unique to this FeatureView. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to sync data to the online store. "serviceAgentType": "A String", # Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate service account to access the BigQuery source table. "syncConfig": { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. + "continuous": True or False, # Optional. If true, syncs the FeatureView in a continuous manner to Online Store. "cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". }, "updateTime": "A String", # Output only. Timestamp when this FeatureView was last updated. @@ -433,6 +434,7 @@

Method Details

"serviceAccountEmail": "A String", # Output only. A Service Account unique to this FeatureView. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to sync data to the online store. "serviceAgentType": "A String", # Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate service account to access the BigQuery source table. "syncConfig": { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. + "continuous": True or False, # Optional. If true, syncs the FeatureView in a continuous manner to Online Store. "cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". }, "updateTime": "A String", # Output only. Timestamp when this FeatureView was last updated. @@ -561,6 +563,7 @@

Method Details

"serviceAccountEmail": "A String", # Output only. A Service Account unique to this FeatureView. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to sync data to the online store. "serviceAgentType": "A String", # Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate service account to access the BigQuery source table. "syncConfig": { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. + "continuous": True or False, # Optional. If true, syncs the FeatureView in a continuous manner to Online Store. "cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". }, "updateTime": "A String", # Output only. Timestamp when this FeatureView was last updated. @@ -660,6 +663,7 @@

Method Details

"serviceAccountEmail": "A String", # Output only. A Service Account unique to this FeatureView. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to sync data to the online store. "serviceAgentType": "A String", # Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate service account to access the BigQuery source table. "syncConfig": { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. + "continuous": True or False, # Optional. If true, syncs the FeatureView in a continuous manner to Online Store. "cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". }, "updateTime": "A String", # Output only. Timestamp when this FeatureView was last updated. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index b98d3cc6c5..1a2328dffd 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -763,7 +763,7 @@

Method Details

}, ], "metricSpec": { # Spec for tool parameter key value match metric. # Required. Spec for tool parameter key value match metric. - "useStrictStringMatch": True or False, # Optional. Whether to use STRCIT string match on parameter values. + "useStrictStringMatch": True or False, # Optional. Whether to use STRICT string match on parameter values. }, }, } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html index 16edfa34cd..bc0de3991b 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html @@ -285,6 +285,9 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -558,6 +561,9 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -873,6 +879,9 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -1159,6 +1168,9 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html index b7a5627875..18342ca5ca 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html @@ -225,6 +225,9 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -316,6 +319,9 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -495,6 +501,9 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -586,6 +595,9 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -807,6 +819,9 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -898,6 +913,9 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -1090,6 +1108,9 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -1181,6 +1202,9 @@

Method Details

"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. "persistentResourceId": "A String", # Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. "protectedArtifactLocationId": "A String", # The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for CustomJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html index 8cb3697c31..1112ba8301 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html @@ -463,6 +463,9 @@

Method Details

}, ], "preflightValidations": True or False, # Optional. Whether to do component level validations before job creation. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -737,6 +740,9 @@

Method Details

}, ], "preflightValidations": True or False, # Optional. Whether to do component level validations before job creation. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -1052,6 +1058,9 @@

Method Details

}, ], "preflightValidations": True or False, # Optional. Whether to do component level validations before job creation. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -1340,6 +1349,9 @@

Method Details

}, ], "preflightValidations": True or False, # Optional. Whether to do component level validations before job creation. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index 0aca34b8b4..d090ad4485 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -228,6 +228,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -241,7 +242,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -333,7 +334,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -367,7 +368,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -488,6 +489,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -501,7 +503,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -607,7 +609,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -641,7 +643,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1209,6 +1211,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -1222,7 +1225,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1328,7 +1331,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1362,7 +1365,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html index 8185b0fee9..bc5efed458 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html @@ -715,6 +715,9 @@

Method Details

}, ], "preflightValidations": True or False, # Optional. Whether to do component level validations before job creation. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -1373,6 +1376,9 @@

Method Details

}, ], "preflightValidations": True or False, # Optional. Whether to do component level validations before job creation. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -2073,6 +2079,9 @@

Method Details

}, ], "preflightValidations": True or False, # Optional. Whether to do component level validations before job creation. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -2745,6 +2754,9 @@

Method Details

}, ], "preflightValidations": True or False, # Optional. Whether to do component level validations before job creation. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -3421,6 +3433,9 @@

Method Details

}, ], "preflightValidations": True or False, # Optional. Whether to do component level validations before job creation. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -4080,6 +4095,9 @@

Method Details

}, ], "preflightValidations": True or False, # Optional. Whether to do component level validations before job creation. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index fd389d7fb4..6d3d458666 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -222,6 +222,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -235,7 +236,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -327,7 +328,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -361,7 +362,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -482,6 +483,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -495,7 +497,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -601,7 +603,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -635,7 +637,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1729,6 +1731,7 @@

Method Details

}, ], "generationConfig": { # Generation config. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. "candidateCount": 42, # Optional. Number of candidates to generate. "frequencyPenalty": 3.14, # Optional. Frequency penalties. "logprobs": 42, # Optional. Logit probabilities. @@ -1742,7 +1745,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1848,7 +1851,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. @@ -1882,7 +1885,7 @@

Method Details

], "default": "", # Optional. Default value of the data. "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} "A String", ], "example": "", # Optional. Example of the object. Will only populated when the object is the root. diff --git a/docs/dyn/androidenterprise_v1.devices.html b/docs/dyn/androidenterprise_v1.devices.html index bfcb4b0419..4b7bb4a18f 100644 --- a/docs/dyn/androidenterprise_v1.devices.html +++ b/docs/dyn/androidenterprise_v1.devices.html @@ -146,6 +146,7 @@

Method Details

"durationMs": "A String", # Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive). "startTimeAfterMidnightMs": "A String", # Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight. }, + "policyId": "A String", # An identifier for the policy that will be passed with the app install feedback sent from the Play Store. "productAvailabilityPolicy": "A String", # The availability granted to the device for the specified products. "all" gives the device access to all products, regardless of approval status. "all" does not enable automatic visibility of "alpha" or "beta" tracks. "whitelist" grants the device access the products specified in productPolicy[]. Only products that are approved or products that were previously approved (products with revoked approval) by the enterprise can be whitelisted. If no value is provided, the availability set at the user level is applied by default. "productPolicy": [ # The list of product policies. The productAvailabilityPolicy needs to be set to WHITELIST or ALL for the product policies to be applied. { # The policy for a product. @@ -288,6 +289,7 @@

Method Details

"durationMs": "A String", # Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive). "startTimeAfterMidnightMs": "A String", # Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight. }, + "policyId": "A String", # An identifier for the policy that will be passed with the app install feedback sent from the Play Store. "productAvailabilityPolicy": "A String", # The availability granted to the device for the specified products. "all" gives the device access to all products, regardless of approval status. "all" does not enable automatic visibility of "alpha" or "beta" tracks. "whitelist" grants the device access the products specified in productPolicy[]. Only products that are approved or products that were previously approved (products with revoked approval) by the enterprise can be whitelisted. If no value is provided, the availability set at the user level is applied by default. "productPolicy": [ # The list of product policies. The productAvailabilityPolicy needs to be set to WHITELIST or ALL for the product policies to be applied. { # The policy for a product. @@ -433,6 +435,7 @@

Method Details

"durationMs": "A String", # Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive). "startTimeAfterMidnightMs": "A String", # Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight. }, + "policyId": "A String", # An identifier for the policy that will be passed with the app install feedback sent from the Play Store. "productAvailabilityPolicy": "A String", # The availability granted to the device for the specified products. "all" gives the device access to all products, regardless of approval status. "all" does not enable automatic visibility of "alpha" or "beta" tracks. "whitelist" grants the device access the products specified in productPolicy[]. Only products that are approved or products that were previously approved (products with revoked approval) by the enterprise can be whitelisted. If no value is provided, the availability set at the user level is applied by default. "productPolicy": [ # The list of product policies. The productAvailabilityPolicy needs to be set to WHITELIST or ALL for the product policies to be applied. { # The policy for a product. @@ -545,6 +548,7 @@

Method Details

"durationMs": "A String", # Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive). "startTimeAfterMidnightMs": "A String", # Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight. }, + "policyId": "A String", # An identifier for the policy that will be passed with the app install feedback sent from the Play Store. "productAvailabilityPolicy": "A String", # The availability granted to the device for the specified products. "all" gives the device access to all products, regardless of approval status. "all" does not enable automatic visibility of "alpha" or "beta" tracks. "whitelist" grants the device access the products specified in productPolicy[]. Only products that are approved or products that were previously approved (products with revoked approval) by the enterprise can be whitelisted. If no value is provided, the availability set at the user level is applied by default. "productPolicy": [ # The list of product policies. The productAvailabilityPolicy needs to be set to WHITELIST or ALL for the product policies to be applied. { # The policy for a product. diff --git a/docs/dyn/androidpublisher_v3.applications.deviceTierConfigs.html b/docs/dyn/androidpublisher_v3.applications.deviceTierConfigs.html index fd03136b71..55e533fd17 100644 --- a/docs/dyn/androidpublisher_v3.applications.deviceTierConfigs.html +++ b/docs/dyn/androidpublisher_v3.applications.deviceTierConfigs.html @@ -135,6 +135,12 @@

Method Details

"name": "A String", # The name of the feature. }, ], + "systemOnChips": [ # Optional. The SoCs included by this selector. Only works for Android S+ devices. + { # Representation of a System-on-Chip (SoC) of an Android device. Can be used to target S+ devices. + "manufacturer": "A String", # Required. The designer of the SoC, eg. "Google" Value of build property "ro.soc.manufacturer" https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER Required. + "model": "A String", # Required. The model of the SoC, eg. "Tensor" Value of build property "ro.soc.model" https://developer.android.com/reference/android/os/Build#SOC_MODEL Required. + }, + ], }, ], "name": "A String", # The name of the group. @@ -201,6 +207,12 @@

Method Details

"name": "A String", # The name of the feature. }, ], + "systemOnChips": [ # Optional. The SoCs included by this selector. Only works for Android S+ devices. + { # Representation of a System-on-Chip (SoC) of an Android device. Can be used to target S+ devices. + "manufacturer": "A String", # Required. The designer of the SoC, eg. "Google" Value of build property "ro.soc.manufacturer" https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER Required. + "model": "A String", # Required. The model of the SoC, eg. "Tensor" Value of build property "ro.soc.model" https://developer.android.com/reference/android/os/Build#SOC_MODEL Required. + }, + ], }, ], "name": "A String", # The name of the group. @@ -274,6 +286,12 @@

Method Details

"name": "A String", # The name of the feature. }, ], + "systemOnChips": [ # Optional. The SoCs included by this selector. Only works for Android S+ devices. + { # Representation of a System-on-Chip (SoC) of an Android device. Can be used to target S+ devices. + "manufacturer": "A String", # Required. The designer of the SoC, eg. "Google" Value of build property "ro.soc.manufacturer" https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER Required. + "model": "A String", # Required. The model of the SoC, eg. "Tensor" Value of build property "ro.soc.model" https://developer.android.com/reference/android/os/Build#SOC_MODEL Required. + }, + ], }, ], "name": "A String", # The name of the group. @@ -350,6 +368,12 @@

Method Details

"name": "A String", # The name of the feature. }, ], + "systemOnChips": [ # Optional. The SoCs included by this selector. Only works for Android S+ devices. + { # Representation of a System-on-Chip (SoC) of an Android device. Can be used to target S+ devices. + "manufacturer": "A String", # Required. The designer of the SoC, eg. "Google" Value of build property "ro.soc.manufacturer" https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER Required. + "model": "A String", # Required. The model of the SoC, eg. "Tensor" Value of build property "ro.soc.model" https://developer.android.com/reference/android/os/Build#SOC_MODEL Required. + }, + ], }, ], "name": "A String", # The name of the group. diff --git a/docs/dyn/apigee_v1.organizations.securityProfilesV2.html b/docs/dyn/apigee_v1.organizations.securityProfilesV2.html index 53a1c2b3fa..26006f33fa 100644 --- a/docs/dyn/apigee_v1.organizations.securityProfilesV2.html +++ b/docs/dyn/apigee_v1.organizations.securityProfilesV2.html @@ -106,7 +106,7 @@

Method Details

Create a security profile v2.
 
 Args:
-  parent: string, Required. The parent resource name. (required)
+  parent: string, Required. The parent resource name. Format: `organizations/{org}` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -151,7 +151,7 @@ 

Method Details

Delete a security profile v2.
 
 Args:
-  name: string, Required. The name of the security profile v2 to delete. (required)
+  name: string, Required. The name of the security profile v2 to delete. Format: `organizations/{org}/securityProfilesV2/{profile}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -169,7 +169,7 @@ 

Method Details

Get a security profile v2.
 
 Args:
-  name: string, Required. The security profile id. (required)
+  name: string, Required. The name of the security profile v2 to get. Format: `organizations/{org}/securityProfilesV2/{profile}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -263,7 +263,7 @@ 

Method Details

"updateTime": "A String", # Output only. The time of the security profile update. } - updateMask: string, Required. The list of fields to update. + updateMask: string, Optional. The list of fields to update. Valid fields to update are `description` and `profileAssessmentConfigs`. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/apikeys_v2.projects.locations.keys.html b/docs/dyn/apikeys_v2.projects.locations.keys.html index 7c2931178b..16e77690e8 100644 --- a/docs/dyn/apikeys_v2.projects.locations.keys.html +++ b/docs/dyn/apikeys_v2.projects.locations.keys.html @@ -159,6 +159,7 @@

Method Details

], }, }, + "serviceAccountEmail": "A String", # Optional. The email address of [the service account](https://cloud.google.com/iam/docs/service-accounts) the key is bound to. "uid": "A String", # Output only. Unique id in UUID4 format. "updateTime": "A String", # Output only. A timestamp identifying the time this key was last updated. } @@ -286,6 +287,7 @@

Method Details

], }, }, + "serviceAccountEmail": "A String", # Optional. The email address of [the service account](https://cloud.google.com/iam/docs/service-accounts) the key is bound to. "uid": "A String", # Output only. Unique id in UUID4 format. "updateTime": "A String", # Output only. A timestamp identifying the time this key was last updated. }
@@ -372,6 +374,7 @@

Method Details

], }, }, + "serviceAccountEmail": "A String", # Optional. The email address of [the service account](https://cloud.google.com/iam/docs/service-accounts) the key is bound to. "uid": "A String", # Output only. Unique id in UUID4 format. "updateTime": "A String", # Output only. A timestamp identifying the time this key was last updated. }, @@ -446,6 +449,7 @@

Method Details

], }, }, + "serviceAccountEmail": "A String", # Optional. The email address of [the service account](https://cloud.google.com/iam/docs/service-accounts) the key is bound to. "uid": "A String", # Output only. Unique id in UUID4 format. "updateTime": "A String", # Output only. A timestamp identifying the time this key was last updated. } diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.html index 58a1abc1a4..ff0efb0872 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.html @@ -302,6 +302,12 @@

Method Details

}, ], }, + "vulnerabilityScanningConfig": { # Config on whether to perform vulnerability scanning for resources in this repository, as well as output fields describing current state. # Optional. Config and state for vulnerability scanning of resources within this Repository. + "enablementConfig": "A String", # Optional. Config for whether this repository has vulnerability scanning disabled. + "enablementState": "A String", # Output only. State of feature enablement, combining repository enablement config and API enablement state. + "enablementStateReason": "A String", # Output only. Reason for the repository state. + "lastEnableTime": "A String", # Output only. The last time this repository config was enabled. + }, } repositoryId: string, Required. The repository id to use for this repository. @@ -496,6 +502,12 @@

Method Details

}, ], }, + "vulnerabilityScanningConfig": { # Config on whether to perform vulnerability scanning for resources in this repository, as well as output fields describing current state. # Optional. Config and state for vulnerability scanning of resources within this Repository. + "enablementConfig": "A String", # Optional. Config for whether this repository has vulnerability scanning disabled. + "enablementState": "A String", # Output only. State of feature enablement, combining repository enablement config and API enablement state. + "enablementStateReason": "A String", # Output only. Reason for the repository state. + "lastEnableTime": "A String", # Output only. The last time this repository config was enabled. + }, }
@@ -668,6 +680,12 @@

Method Details

}, ], }, + "vulnerabilityScanningConfig": { # Config on whether to perform vulnerability scanning for resources in this repository, as well as output fields describing current state. # Optional. Config and state for vulnerability scanning of resources within this Repository. + "enablementConfig": "A String", # Optional. Config for whether this repository has vulnerability scanning disabled. + "enablementState": "A String", # Output only. State of feature enablement, combining repository enablement config and API enablement state. + "enablementStateReason": "A String", # Output only. Reason for the repository state. + "lastEnableTime": "A String", # Output only. The last time this repository config was enabled. + }, }, ], }
@@ -809,6 +827,12 @@

Method Details

}, ], }, + "vulnerabilityScanningConfig": { # Config on whether to perform vulnerability scanning for resources in this repository, as well as output fields describing current state. # Optional. Config and state for vulnerability scanning of resources within this Repository. + "enablementConfig": "A String", # Optional. Config for whether this repository has vulnerability scanning disabled. + "enablementState": "A String", # Output only. State of feature enablement, combining repository enablement config and API enablement state. + "enablementStateReason": "A String", # Output only. Reason for the repository state. + "lastEnableTime": "A String", # Output only. The last time this repository config was enabled. + }, } updateMask: string, The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask @@ -933,6 +957,12 @@

Method Details

}, ], }, + "vulnerabilityScanningConfig": { # Config on whether to perform vulnerability scanning for resources in this repository, as well as output fields describing current state. # Optional. Config and state for vulnerability scanning of resources within this Repository. + "enablementConfig": "A String", # Optional. Config for whether this repository has vulnerability scanning disabled. + "enablementState": "A String", # Output only. State of feature enablement, combining repository enablement config and API enablement state. + "enablementStateReason": "A String", # Output only. Reason for the repository state. + "lastEnableTime": "A String", # Output only. The last time this repository config was enabled. + }, }
diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.rules.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.rules.html index 49b3e86ded..07bc6a9ca9 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.rules.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.rules.html @@ -110,17 +110,17 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A Rule applies to repository or package level. It defines the deny or allow action of the operation when the conditions in the rule are met. - "action": "A String", # The action this rule makes. - "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. The condition of the rule in CEL expression. If not provided, the rule matches all the objects. +{ # A rule defines the deny or allow action of the operation it applies to and the conditions required for the rule to apply. You can set one rule for an entire repository and one rule for each package within. + "action": "A String", # The action this rule takes. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. A CEL expression for conditions that must be met in order for the rule to apply. If not provided, the rule matches all objects. "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. }, - "name": "A String", # The name of the rule, for example: "projects/p1/locations/us-central1/repositories/repo1/rules/rule1". + "name": "A String", # The name of the rule, for example: `projects/p1/locations/us-central1/repositories/repo1/rules/rule1`. "operation": "A String", - "packageId": "A String", # The package ID the rule applies to. If empty, this rule applies to all the packages inside the repository. + "packageId": "A String", # The package ID the rule applies to. If empty, this rule applies to all packages inside the repository. } ruleId: string, The rule id to use for this repository. @@ -132,17 +132,17 @@

Method Details

Returns: An object of the form: - { # A Rule applies to repository or package level. It defines the deny or allow action of the operation when the conditions in the rule are met. - "action": "A String", # The action this rule makes. - "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. The condition of the rule in CEL expression. If not provided, the rule matches all the objects. + { # A rule defines the deny or allow action of the operation it applies to and the conditions required for the rule to apply. You can set one rule for an entire repository and one rule for each package within. + "action": "A String", # The action this rule takes. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. A CEL expression for conditions that must be met in order for the rule to apply. If not provided, the rule matches all objects. "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. }, - "name": "A String", # The name of the rule, for example: "projects/p1/locations/us-central1/repositories/repo1/rules/rule1". + "name": "A String", # The name of the rule, for example: `projects/p1/locations/us-central1/repositories/repo1/rules/rule1`. "operation": "A String", - "packageId": "A String", # The package ID the rule applies to. If empty, this rule applies to all the packages inside the repository. + "packageId": "A String", # The package ID the rule applies to. If empty, this rule applies to all packages inside the repository. } @@ -178,17 +178,17 @@

Method Details

Returns: An object of the form: - { # A Rule applies to repository or package level. It defines the deny or allow action of the operation when the conditions in the rule are met. - "action": "A String", # The action this rule makes. - "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. The condition of the rule in CEL expression. If not provided, the rule matches all the objects. + { # A rule defines the deny or allow action of the operation it applies to and the conditions required for the rule to apply. You can set one rule for an entire repository and one rule for each package within. + "action": "A String", # The action this rule takes. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. A CEL expression for conditions that must be met in order for the rule to apply. If not provided, the rule matches all objects. "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. }, - "name": "A String", # The name of the rule, for example: "projects/p1/locations/us-central1/repositories/repo1/rules/rule1". + "name": "A String", # The name of the rule, for example: `projects/p1/locations/us-central1/repositories/repo1/rules/rule1`. "operation": "A String", - "packageId": "A String", # The package ID the rule applies to. If empty, this rule applies to all the packages inside the repository. + "packageId": "A String", # The package ID the rule applies to. If empty, this rule applies to all packages inside the repository. } @@ -211,17 +211,17 @@

Method Details

{ # The response from listing rules. "nextPageToken": "A String", # The token to retrieve the next page of rules, or empty if there are no more rules to return. "rules": [ # The rules returned. - { # A Rule applies to repository or package level. It defines the deny or allow action of the operation when the conditions in the rule are met. - "action": "A String", # The action this rule makes. - "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. The condition of the rule in CEL expression. If not provided, the rule matches all the objects. + { # A rule defines the deny or allow action of the operation it applies to and the conditions required for the rule to apply. You can set one rule for an entire repository and one rule for each package within. + "action": "A String", # The action this rule takes. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. A CEL expression for conditions that must be met in order for the rule to apply. If not provided, the rule matches all objects. "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. }, - "name": "A String", # The name of the rule, for example: "projects/p1/locations/us-central1/repositories/repo1/rules/rule1". + "name": "A String", # The name of the rule, for example: `projects/p1/locations/us-central1/repositories/repo1/rules/rule1`. "operation": "A String", - "packageId": "A String", # The package ID the rule applies to. If empty, this rule applies to all the packages inside the repository. + "packageId": "A String", # The package ID the rule applies to. If empty, this rule applies to all packages inside the repository. }, ], } @@ -246,21 +246,21 @@

Method Details

Updates a rule.
 
 Args:
-  name: string, The name of the rule, for example: "projects/p1/locations/us-central1/repositories/repo1/rules/rule1". (required)
+  name: string, The name of the rule, for example: `projects/p1/locations/us-central1/repositories/repo1/rules/rule1`. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A Rule applies to repository or package level. It defines the deny or allow action of the operation when the conditions in the rule are met.
-  "action": "A String", # The action this rule makes.
-  "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. The condition of the rule in CEL expression. If not provided, the rule matches all the objects.
+{ # A rule defines the deny or allow action of the operation it applies to and the conditions required for the rule to apply. You can set one rule for an entire repository and one rule for each package within.
+  "action": "A String", # The action this rule takes.
+  "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. A CEL expression for conditions that must be met in order for the rule to apply. If not provided, the rule matches all objects.
     "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
     "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
     "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
     "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
   },
-  "name": "A String", # The name of the rule, for example: "projects/p1/locations/us-central1/repositories/repo1/rules/rule1".
+  "name": "A String", # The name of the rule, for example: `projects/p1/locations/us-central1/repositories/repo1/rules/rule1`.
   "operation": "A String",
-  "packageId": "A String", # The package ID the rule applies to. If empty, this rule applies to all the packages inside the repository.
+  "packageId": "A String", # The package ID the rule applies to. If empty, this rule applies to all packages inside the repository.
 }
 
   updateMask: string, The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
@@ -272,17 +272,17 @@ 

Method Details

Returns: An object of the form: - { # A Rule applies to repository or package level. It defines the deny or allow action of the operation when the conditions in the rule are met. - "action": "A String", # The action this rule makes. - "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. The condition of the rule in CEL expression. If not provided, the rule matches all the objects. + { # A rule defines the deny or allow action of the operation it applies to and the conditions required for the rule to apply. You can set one rule for an entire repository and one rule for each package within. + "action": "A String", # The action this rule takes. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. A CEL expression for conditions that must be met in order for the rule to apply. If not provided, the rule matches all objects. "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. }, - "name": "A String", # The name of the rule, for example: "projects/p1/locations/us-central1/repositories/repo1/rules/rule1". + "name": "A String", # The name of the rule, for example: `projects/p1/locations/us-central1/repositories/repo1/rules/rule1`. "operation": "A String", - "packageId": "A String", # The package ID the rule applies to. If empty, this rule applies to all the packages inside the repository. + "packageId": "A String", # The package ID the rule applies to. If empty, this rule applies to all packages inside the repository. }
diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html index eae9e1fab1..19970a4729 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html @@ -145,7 +145,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` - "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket". + "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance" and "storage.googleapis.com/Bucket". "state": "A String", # Output only. The `State` for the `BackupPlan`. "updateTime": "A String", # Output only. When the `BackupPlan` was last updated. } @@ -269,7 +269,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` - "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket". + "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance" and "storage.googleapis.com/Bucket". "state": "A String", # Output only. The `State` for the `BackupPlan`. "updateTime": "A String", # Output only. When the `BackupPlan` was last updated. } @@ -333,7 +333,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` - "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket". + "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance" and "storage.googleapis.com/Bucket". "state": "A String", # Output only. The `State` for the `BackupPlan`. "updateTime": "A String", # Output only. When the `BackupPlan` was last updated. }, diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.html index a0908ea9a3..96ff5a60ca 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.html @@ -86,7 +86,7 @@

Instance Methods

create(parent, backupVaultId=None, body=None, requestId=None, validateOnly=None, x__xgafv=None)

Creates a new BackupVault in a given project and location.

- delete(name, allowMissing=None, etag=None, force=None, requestId=None, validateOnly=None, x__xgafv=None)

+ delete(name, allowMissing=None, etag=None, force=None, ignoreBackupPlanReferences=None, requestId=None, validateOnly=None, x__xgafv=None)

Deletes a BackupVault.

fetchUsable(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

@@ -180,7 +180,7 @@

Method Details

- delete(name, allowMissing=None, etag=None, force=None, requestId=None, validateOnly=None, x__xgafv=None) + delete(name, allowMissing=None, etag=None, force=None, ignoreBackupPlanReferences=None, requestId=None, validateOnly=None, x__xgafv=None)
Deletes a BackupVault.
 
 Args:
@@ -188,6 +188,7 @@ 

Method Details

allowMissing: boolean, Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken. etag: string, The current etag of the backup vault. If an etag is provided and does not match the current etag of the connection, deletion will be blocked. force: boolean, Optional. If set to true, any data source from this backup vault will also be deleted. + ignoreBackupPlanReferences: boolean, Optional. If set to true, backupvault deletion will proceed even if there are backup plans referencing the backupvault. The default is 'false'. requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is 'false'. x__xgafv: string, V1 error format. diff --git a/docs/dyn/beyondcorp_v1.html b/docs/dyn/beyondcorp_v1.html index 75b3d67705..fe7bf91dec 100644 --- a/docs/dyn/beyondcorp_v1.html +++ b/docs/dyn/beyondcorp_v1.html @@ -84,6 +84,11 @@

Instance Methods

Returns the projects Resource.

+

+ v() +

+

Returns the v Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/beyondcorp_v1.projects.locations.global_.securityGateways.applications.html b/docs/dyn/beyondcorp_v1.projects.locations.global_.securityGateways.applications.html index 48aaa885a8..418b559cda 100644 --- a/docs/dyn/beyondcorp_v1.projects.locations.global_.securityGateways.applications.html +++ b/docs/dyn/beyondcorp_v1.projects.locations.global_.securityGateways.applications.html @@ -83,6 +83,9 @@

Instance Methods

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

Updates the parameters of a single Application.

+

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

+

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

Method Details

close() @@ -199,4 +202,34 @@

Method Details

}
+
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.applications.html b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.applications.html index 955fcc2a8c..31897055ed 100644 --- a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.applications.html +++ b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.applications.html @@ -83,12 +83,18 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single Application.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

+

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

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

Lists Applications in a given project and location.

list_next()

Retrieves the next page of results.

+

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

+

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

Method Details

close() @@ -162,6 +168,54 @@

Method Details

}
+
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Applications in a given project and location.
@@ -218,4 +272,89 @@ 

Method Details

+
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html index 1224704db5..b06ad15494 100644 --- a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html +++ b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html @@ -91,6 +91,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single SecurityGateway.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

+

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

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

Lists SecurityGateways in a given project and location.

@@ -103,6 +106,9 @@

Instance Methods

setPeering(securityGateway, body=None, x__xgafv=None)

This is a custom method to allow customers to create a peering connections between Google network and customer networks. This is enabled only for the allowlisted customers.

+

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

+

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

Method Details

close() @@ -241,6 +247,54 @@

Method Details

}
+
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists SecurityGateways in a given project and location.
@@ -377,7 +431,7 @@ 

Method Details

"dnsZones": [ # Optional. List of DNS zones for DNS peering with the customer VPC network. "A String", ], - "targetVpcNetwork": "A String", # Required. The name of the Target VPC network name in the format: `projects/{project}/global/networks/{network} + "targetNetwork": "A String", # Required. The name of the Target VPC network name in the format: `projects/{project}/global/networks/{network} }, ], "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). @@ -413,4 +467,34 @@

Method Details

}
+
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/beyondcorp_v1.v.html b/docs/dyn/beyondcorp_v1.v.html new file mode 100644 index 0000000000..71576290c0 --- /dev/null +++ b/docs/dyn/beyondcorp_v1.v.html @@ -0,0 +1,91 @@ + + + +

BeyondCorp API . v

+

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/beyondcorp_v1.v.projects.html b/docs/dyn/beyondcorp_v1.v.projects.html new file mode 100644 index 0000000000..55977f0b36 --- /dev/null +++ b/docs/dyn/beyondcorp_v1.v.projects.html @@ -0,0 +1,91 @@ + + + +

BeyondCorp API . v . projects

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/beyondcorp_v1.v.projects.locations.html b/docs/dyn/beyondcorp_v1.v.projects.locations.html new file mode 100644 index 0000000000..54621a588b --- /dev/null +++ b/docs/dyn/beyondcorp_v1.v.projects.locations.html @@ -0,0 +1,91 @@ + + + +

BeyondCorp API . v . projects . locations

+

Instance Methods

+

+ securityGateways() +

+

Returns the securityGateways Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/beyondcorp_v1.v.projects.locations.securityGateways.html b/docs/dyn/beyondcorp_v1.v.projects.locations.securityGateways.html new file mode 100644 index 0000000000..3a3417c709 --- /dev/null +++ b/docs/dyn/beyondcorp_v1.v.projects.locations.securityGateways.html @@ -0,0 +1,174 @@ + + + +

BeyondCorp API . v . projects . locations . securityGateways

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html index 75b7cf4cef..0aeb17e69a 100644 --- a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html @@ -519,7 +519,7 @@

Method Details

"dnsZones": [ # Optional. List of DNS zones for DNS peering with the customer VPC network. "A String", ], - "targetVpcNetwork": "A String", # Required. The name of the Target VPC network name in the format: `projects/{project}/global/networks/{network} + "targetNetwork": "A String", # Required. The name of the Target VPC network name in the format: `projects/{project}/global/networks/{network} }, ], "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). diff --git a/docs/dyn/bigquery_v2.datasets.html b/docs/dyn/bigquery_v2.datasets.html index 2ece80093a..9a0fc39ef3 100644 --- a/docs/dyn/bigquery_v2.datasets.html +++ b/docs/dyn/bigquery_v2.datasets.html @@ -81,10 +81,10 @@

Instance Methods

delete(projectId, datasetId, deleteContents=None, x__xgafv=None)

Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.

- get(projectId, datasetId, datasetView=None, x__xgafv=None)

+ get(projectId, datasetId, accessPolicyVersion=None, datasetView=None, x__xgafv=None)

Returns the dataset specified by datasetID.

- insert(projectId, body=None, x__xgafv=None)

+ insert(projectId, accessPolicyVersion=None, body=None, x__xgafv=None)

Creates a new empty dataset.

list(projectId, all=None, filter=None, maxResults=None, pageToken=None, x__xgafv=None)

@@ -93,13 +93,13 @@

Instance Methods

list_next()

Retrieves the next page of results.

- patch(projectId, datasetId, body=None, x__xgafv=None)

+ patch(projectId, datasetId, accessPolicyVersion=None, body=None, x__xgafv=None)

Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports RFC5789 patch semantics.

undelete(projectId, datasetId, body=None, x__xgafv=None)

Undeletes a dataset which is within time travel window based on datasetId. If a time is specified, the dataset version deleted at that time is undeleted, else the last live version is undeleted.

- update(projectId, datasetId, body=None, x__xgafv=None)

+ update(projectId, datasetId, accessPolicyVersion=None, body=None, x__xgafv=None)

Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource.

Method Details

@@ -123,12 +123,13 @@

Method Details

- get(projectId, datasetId, datasetView=None, x__xgafv=None) + get(projectId, datasetId, accessPolicyVersion=None, datasetView=None, x__xgafv=None)
Returns the dataset specified by datasetID.
 
 Args:
   projectId: string, Required. Project ID of the requested dataset (required)
   datasetId: string, Required. Dataset ID of the requested dataset (required)
+  accessPolicyVersion: integer, Optional. The version of the access policy schema to fetch. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for conditional access policy binding in datasets must specify version 3. Dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. This field will be maped to [IAM Policy version] (https://cloud.google.com/iam/docs/policies#versions) and will be used to fetch policy from IAM. If unset or if 0 or 1 value is used for dataset with conditional bindings, access entry with condition will have role string appended by 'withcond' string followed by a hash value. For example : { "access": [ { "role": "roles/bigquery.dataViewer_with_conditionalbinding_7a34awqsda", "userByEmail": "user@example.com", } ] } Please refer https://cloud.google.com/iam/docs/troubleshooting-withcond for more details.
   datasetView: string, Optional. Specifies the view that determines which dataset information is returned. By default, metadata and ACL information are returned.
     Allowed values
       DATASET_VIEW_UNSPECIFIED - The default value. Default to the FULL view.
@@ -146,6 +147,12 @@ 

Method Details

{ # Represents a BigQuery dataset. "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add. { # An object that defines dataset access for an entity. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. condition for the binding. If CEL expression in this field is true, this access binding will be considered + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, "dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation. "dataset": { # Identifier for a dataset. # The dataset this entry applies to "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -237,7 +244,7 @@

Method Details

- insert(projectId, body=None, x__xgafv=None) + insert(projectId, accessPolicyVersion=None, body=None, x__xgafv=None)
Creates a new empty dataset.
 
 Args:
@@ -248,6 +255,12 @@ 

Method Details

{ # Represents a BigQuery dataset. "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add. { # An object that defines dataset access for an entity. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. condition for the binding. If CEL expression in this field is true, this access binding will be considered + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, "dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation. "dataset": { # Identifier for a dataset. # The dataset this entry applies to "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -337,6 +350,7 @@

Method Details

"type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog. } + accessPolicyVersion: integer, Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Requests with conditional access policy binding in datasets must specify version 3. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be maped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -348,6 +362,12 @@

Method Details

{ # Represents a BigQuery dataset. "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add. { # An object that defines dataset access for an entity. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. condition for the binding. If CEL expression in this field is true, this access binding will be considered + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, "dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation. "dataset": { # Identifier for a dataset. # The dataset this entry applies to "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -496,7 +516,7 @@

Method Details

- patch(projectId, datasetId, body=None, x__xgafv=None) + patch(projectId, datasetId, accessPolicyVersion=None, body=None, x__xgafv=None)
Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports RFC5789 patch semantics.
 
 Args:
@@ -508,6 +528,12 @@ 

Method Details

{ # Represents a BigQuery dataset. "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add. { # An object that defines dataset access for an entity. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. condition for the binding. If CEL expression in this field is true, this access binding will be considered + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, "dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation. "dataset": { # Identifier for a dataset. # The dataset this entry applies to "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -597,6 +623,7 @@

Method Details

"type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog. } + accessPolicyVersion: integer, Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Operations updating conditional access policy binding in datasets must specify version 3. Some of the operations are : - Adding a new access policy entry with condition. - Removing an access policy entry with condition. - Updating an access policy entry with condition. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be maped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -608,6 +635,12 @@

Method Details

{ # Represents a BigQuery dataset. "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add. { # An object that defines dataset access for an entity. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. condition for the binding. If CEL expression in this field is true, this access binding will be considered + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, "dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation. "dataset": { # Identifier for a dataset. # The dataset this entry applies to "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -723,6 +756,12 @@

Method Details

{ # Represents a BigQuery dataset. "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add. { # An object that defines dataset access for an entity. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. condition for the binding. If CEL expression in this field is true, this access binding will be considered + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, "dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation. "dataset": { # Identifier for a dataset. # The dataset this entry applies to "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -814,7 +853,7 @@

Method Details

- update(projectId, datasetId, body=None, x__xgafv=None) + update(projectId, datasetId, accessPolicyVersion=None, body=None, x__xgafv=None)
Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource.
 
 Args:
@@ -826,6 +865,12 @@ 

Method Details

{ # Represents a BigQuery dataset. "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add. { # An object that defines dataset access for an entity. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. condition for the binding. If CEL expression in this field is true, this access binding will be considered + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, "dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation. "dataset": { # Identifier for a dataset. # The dataset this entry applies to "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -915,6 +960,7 @@

Method Details

"type": "A String", # Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog. } + accessPolicyVersion: integer, Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Operations updating conditional access policy binding in datasets must specify version 3. Some of the operations are : - Adding a new access policy entry with condition. - Removing an access policy entry with condition. - Updating an access policy entry with condition. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be maped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -926,6 +972,12 @@

Method Details

{ # Represents a BigQuery dataset. "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add. { # An object that defines dataset access for an entity. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. condition for the binding. If CEL expression in this field is true, this access binding will be considered + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, "dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation. "dataset": { # Identifier for a dataset. # The dataset this entry applies to "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.html b/docs/dyn/bigqueryreservation_v1.projects.locations.html index 7701a50105..1d16536298 100644 --- a/docs/dyn/bigqueryreservation_v1.projects.locations.html +++ b/docs/dyn/bigqueryreservation_v1.projects.locations.html @@ -160,6 +160,7 @@

Method Details

"assignments": [ # List of assignments visible to the user. { # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation. "assignee": "A String", # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. + "enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. "jobType": "A String", # Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "state": "A String", # Output only. State of the assignment. @@ -204,6 +205,7 @@

Method Details

"assignments": [ # List of assignments visible to the user. { # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation. "assignee": "A String", # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. + "enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. "jobType": "A String", # Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "state": "A String", # Output only. State of the assignment. diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html index 1680dd28d9..e42d0d76ad 100644 --- a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html +++ b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html @@ -112,6 +112,7 @@

Method Details

{ # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation. "assignee": "A String", # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. + "enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. "jobType": "A String", # Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "state": "A String", # Output only. State of the assignment. @@ -128,6 +129,7 @@

Method Details

{ # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation. "assignee": "A String", # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. + "enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. "jobType": "A String", # Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "state": "A String", # Output only. State of the assignment. @@ -172,6 +174,7 @@

Method Details

"assignments": [ # List of assignments visible to the user. { # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation. "assignee": "A String", # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. + "enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. "jobType": "A String", # Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "state": "A String", # Output only. State of the assignment. @@ -219,6 +222,7 @@

Method Details

{ # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation. "assignee": "A String", # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. + "enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. "jobType": "A String", # Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "state": "A String", # Output only. State of the assignment. @@ -236,6 +240,7 @@

Method Details

{ # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation. "assignee": "A String", # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. + "enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. "jobType": "A String", # Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "state": "A String", # Output only. State of the assignment. @@ -252,6 +257,7 @@

Method Details

{ # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation. "assignee": "A String", # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. + "enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. "jobType": "A String", # Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "state": "A String", # Output only. State of the assignment. diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.html b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.html index c16e737539..53ac5fc44f 100644 --- a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.html +++ b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.html @@ -120,13 +120,16 @@

Method Details

{ # A reservation is a mechanism used to guarantee slots to users. "autoscale": { # Auto scaling settings. # The configuration parameters for the auto scaling feature. - "currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. + "currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. Note: after users reduce max_slots, it may take a while before it can be propagated, so current_slots may stay in the original value and could be larger than max_slots for that brief period (less than one minute) "maxSlots": "A String", # Number of slots to be scaled when needed. }, "concurrency": "A String", # Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target job concurrency in the Information Schema, DDL and BQ CLI. "creationTime": "A String", # Output only. Creation time of the reservation. "edition": "A String", # Edition of the reservation. "ignoreIdleSlots": True or False, # If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most. + "labels": { # Optional. The labels associated with this reservation. You can use these to organize and group your reservations. You can set this property when inserting or updating a reservation. + "a_key": "A String", + }, "multiRegionAuxiliary": True or False, # Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field. "name": "A String", # The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. "originalPrimaryLocation": "A String", # Optional. The original primary location of the reservation which is set only during its creation and remains unchanged afterwards. It can be used by the customer to answer questions about disaster recovery billing. The field is output only for customers and should not be specified, however, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions. @@ -147,13 +150,16 @@

Method Details

{ # A reservation is a mechanism used to guarantee slots to users. "autoscale": { # Auto scaling settings. # The configuration parameters for the auto scaling feature. - "currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. + "currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. Note: after users reduce max_slots, it may take a while before it can be propagated, so current_slots may stay in the original value and could be larger than max_slots for that brief period (less than one minute) "maxSlots": "A String", # Number of slots to be scaled when needed. }, "concurrency": "A String", # Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target job concurrency in the Information Schema, DDL and BQ CLI. "creationTime": "A String", # Output only. Creation time of the reservation. "edition": "A String", # Edition of the reservation. "ignoreIdleSlots": True or False, # If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most. + "labels": { # Optional. The labels associated with this reservation. You can use these to organize and group your reservations. You can set this property when inserting or updating a reservation. + "a_key": "A String", + }, "multiRegionAuxiliary": True or False, # Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field. "name": "A String", # The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. "originalPrimaryLocation": "A String", # Optional. The original primary location of the reservation which is set only during its creation and remains unchanged afterwards. It can be used by the customer to answer questions about disaster recovery billing. The field is output only for customers and should not be specified, however, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions. @@ -204,13 +210,16 @@

Method Details

{ # A reservation is a mechanism used to guarantee slots to users. "autoscale": { # Auto scaling settings. # The configuration parameters for the auto scaling feature. - "currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. + "currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. Note: after users reduce max_slots, it may take a while before it can be propagated, so current_slots may stay in the original value and could be larger than max_slots for that brief period (less than one minute) "maxSlots": "A String", # Number of slots to be scaled when needed. }, "concurrency": "A String", # Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target job concurrency in the Information Schema, DDL and BQ CLI. "creationTime": "A String", # Output only. Creation time of the reservation. "edition": "A String", # Edition of the reservation. "ignoreIdleSlots": True or False, # If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most. + "labels": { # Optional. The labels associated with this reservation. You can use these to organize and group your reservations. You can set this property when inserting or updating a reservation. + "a_key": "A String", + }, "multiRegionAuxiliary": True or False, # Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field. "name": "A String", # The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. "originalPrimaryLocation": "A String", # Optional. The original primary location of the reservation which is set only during its creation and remains unchanged afterwards. It can be used by the customer to answer questions about disaster recovery billing. The field is output only for customers and should not be specified, however, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions. @@ -237,13 +246,16 @@

Method Details

{ # A reservation is a mechanism used to guarantee slots to users. "autoscale": { # Auto scaling settings. # The configuration parameters for the auto scaling feature. - "currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. + "currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. Note: after users reduce max_slots, it may take a while before it can be propagated, so current_slots may stay in the original value and could be larger than max_slots for that brief period (less than one minute) "maxSlots": "A String", # Number of slots to be scaled when needed. }, "concurrency": "A String", # Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target job concurrency in the Information Schema, DDL and BQ CLI. "creationTime": "A String", # Output only. Creation time of the reservation. "edition": "A String", # Edition of the reservation. "ignoreIdleSlots": True or False, # If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most. + "labels": { # Optional. The labels associated with this reservation. You can use these to organize and group your reservations. You can set this property when inserting or updating a reservation. + "a_key": "A String", + }, "multiRegionAuxiliary": True or False, # Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field. "name": "A String", # The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. "originalPrimaryLocation": "A String", # Optional. The original primary location of the reservation which is set only during its creation and remains unchanged afterwards. It can be used by the customer to answer questions about disaster recovery billing. The field is output only for customers and should not be specified, however, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions. @@ -275,13 +287,16 @@

Method Details

"reservations": [ # List of reservations visible to the user. { # A reservation is a mechanism used to guarantee slots to users. "autoscale": { # Auto scaling settings. # The configuration parameters for the auto scaling feature. - "currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. + "currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. Note: after users reduce max_slots, it may take a while before it can be propagated, so current_slots may stay in the original value and could be larger than max_slots for that brief period (less than one minute) "maxSlots": "A String", # Number of slots to be scaled when needed. }, "concurrency": "A String", # Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target job concurrency in the Information Schema, DDL and BQ CLI. "creationTime": "A String", # Output only. Creation time of the reservation. "edition": "A String", # Edition of the reservation. "ignoreIdleSlots": True or False, # If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most. + "labels": { # Optional. The labels associated with this reservation. You can use these to organize and group your reservations. You can set this property when inserting or updating a reservation. + "a_key": "A String", + }, "multiRegionAuxiliary": True or False, # Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field. "name": "A String", # The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. "originalPrimaryLocation": "A String", # Optional. The original primary location of the reservation which is set only during its creation and remains unchanged afterwards. It can be used by the customer to answer questions about disaster recovery billing. The field is output only for customers and should not be specified, however, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions. @@ -319,13 +334,16 @@

Method Details

{ # A reservation is a mechanism used to guarantee slots to users. "autoscale": { # Auto scaling settings. # The configuration parameters for the auto scaling feature. - "currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. + "currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. Note: after users reduce max_slots, it may take a while before it can be propagated, so current_slots may stay in the original value and could be larger than max_slots for that brief period (less than one minute) "maxSlots": "A String", # Number of slots to be scaled when needed. }, "concurrency": "A String", # Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target job concurrency in the Information Schema, DDL and BQ CLI. "creationTime": "A String", # Output only. Creation time of the reservation. "edition": "A String", # Edition of the reservation. "ignoreIdleSlots": True or False, # If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most. + "labels": { # Optional. The labels associated with this reservation. You can use these to organize and group your reservations. You can set this property when inserting or updating a reservation. + "a_key": "A String", + }, "multiRegionAuxiliary": True or False, # Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field. "name": "A String", # The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. "originalPrimaryLocation": "A String", # Optional. The original primary location of the reservation which is set only during its creation and remains unchanged afterwards. It can be used by the customer to answer questions about disaster recovery billing. The field is output only for customers and should not be specified, however, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions. @@ -346,13 +364,16 @@

Method Details

{ # A reservation is a mechanism used to guarantee slots to users. "autoscale": { # Auto scaling settings. # The configuration parameters for the auto scaling feature. - "currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. + "currentSlots": "A String", # Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. Note: after users reduce max_slots, it may take a while before it can be propagated, so current_slots may stay in the original value and could be larger than max_slots for that brief period (less than one minute) "maxSlots": "A String", # Number of slots to be scaled when needed. }, "concurrency": "A String", # Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target job concurrency in the Information Schema, DDL and BQ CLI. "creationTime": "A String", # Output only. Creation time of the reservation. "edition": "A String", # Edition of the reservation. "ignoreIdleSlots": True or False, # If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most. + "labels": { # Optional. The labels associated with this reservation. You can use these to organize and group your reservations. You can set this property when inserting or updating a reservation. + "a_key": "A String", + }, "multiRegionAuxiliary": True or False, # Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field. "name": "A String", # The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. "originalPrimaryLocation": "A String", # Optional. The original primary location of the reservation which is set only during its creation and remains unchanged afterwards. It can be used by the customer to answer questions about disaster recovery billing. The field is output only for customers and should not be specified, however, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions. diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html index 0034491c9b..f0f359968d 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html @@ -180,7 +180,7 @@

Method Details

], "table": { # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. # Required. The Table to create. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. - "frequency": "A String", # Required. How frequently automated backups should occur. The only supported value at this time is 24 hours. + "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. "retentionPeriod": "A String", # Required. How long the automated backups should be retained. The only supported value at this time is 3 days. }, "changeStreamConfig": { # Change stream configuration. # If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained. @@ -227,16 +227,16 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations - "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, - "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. + "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`. Use `AddInput` mutations to accumulate new inputs. "max": { # Computes the max of the input values. Allowed input: `Int64` State: same as input # Max aggregator. }, "min": { # Computes the min of the input values. Allowed input: `Int64` State: same as input # Min aggregator. }, - "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. + "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen. "sum": { # Computes the sum of the input values. Allowed input: `Int64` State: same as input # Sum aggregator. }, }, @@ -246,8 +246,8 @@

Method Details

"boolType": { # bool Values of type `Bool` are stored in `Value.bool_value`. # Bool }, "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "raw": { # Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A # Use `Raw` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. }, }, }, @@ -258,11 +258,11 @@

Method Details

"float64Type": { # Float64 Values of type `Float64` are stored in `Value.float_value`. # Float64 }, "int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64 - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "bigEndianBytes": { # Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Order-preserving? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "raw": { # Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A # Use `Raw` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. }, }, }, @@ -274,8 +274,8 @@

Method Details

"valueType": # Object with schema name: Type # The type of the values in a map. }, "stringType": { # String Values of type `String` are stored in `Value.string_value`. # String - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "utf8Bytes": { # UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. }, "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. }, @@ -327,7 +327,7 @@

Method Details

{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. - "frequency": "A String", # Required. How frequently automated backups should occur. The only supported value at this time is 24 hours. + "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. "retentionPeriod": "A String", # Required. How long the automated backups should be retained. The only supported value at this time is 3 days. }, "changeStreamConfig": { # Change stream configuration. # If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained. @@ -374,16 +374,16 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations - "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, - "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. + "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`. Use `AddInput` mutations to accumulate new inputs. "max": { # Computes the max of the input values. Allowed input: `Int64` State: same as input # Max aggregator. }, "min": { # Computes the min of the input values. Allowed input: `Int64` State: same as input # Min aggregator. }, - "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. + "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen. "sum": { # Computes the sum of the input values. Allowed input: `Int64` State: same as input # Sum aggregator. }, }, @@ -393,8 +393,8 @@

Method Details

"boolType": { # bool Values of type `Bool` are stored in `Value.bool_value`. # Bool }, "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "raw": { # Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A # Use `Raw` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. }, }, }, @@ -405,11 +405,11 @@

Method Details

"float64Type": { # Float64 Values of type `Float64` are stored in `Value.float_value`. # Float64 }, "int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64 - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "bigEndianBytes": { # Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Order-preserving? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "raw": { # Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A # Use `Raw` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. }, }, }, @@ -421,8 +421,8 @@

Method Details

"valueType": # Object with schema name: Type # The type of the values in a map. }, "stringType": { # String Values of type `String` are stored in `Value.string_value`. # String - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "utf8Bytes": { # UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. }, "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. }, @@ -557,7 +557,7 @@

Method Details

{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. - "frequency": "A String", # Required. How frequently automated backups should occur. The only supported value at this time is 24 hours. + "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. "retentionPeriod": "A String", # Required. How long the automated backups should be retained. The only supported value at this time is 3 days. }, "changeStreamConfig": { # Change stream configuration. # If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained. @@ -604,16 +604,16 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations - "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, - "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. + "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`. Use `AddInput` mutations to accumulate new inputs. "max": { # Computes the max of the input values. Allowed input: `Int64` State: same as input # Max aggregator. }, "min": { # Computes the min of the input values. Allowed input: `Int64` State: same as input # Min aggregator. }, - "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. + "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen. "sum": { # Computes the sum of the input values. Allowed input: `Int64` State: same as input # Sum aggregator. }, }, @@ -623,8 +623,8 @@

Method Details

"boolType": { # bool Values of type `Bool` are stored in `Value.bool_value`. # Bool }, "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "raw": { # Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A # Use `Raw` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. }, }, }, @@ -635,11 +635,11 @@

Method Details

"float64Type": { # Float64 Values of type `Float64` are stored in `Value.float_value`. # Float64 }, "int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64 - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "bigEndianBytes": { # Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Order-preserving? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "raw": { # Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A # Use `Raw` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. }, }, }, @@ -651,8 +651,8 @@

Method Details

"valueType": # Object with schema name: Type # The type of the values in a map. }, "stringType": { # String Values of type `String` are stored in `Value.string_value`. # String - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "utf8Bytes": { # UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. }, "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. }, @@ -779,7 +779,7 @@

Method Details

"tables": [ # The tables present in the requested instance. { # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. - "frequency": "A String", # Required. How frequently automated backups should occur. The only supported value at this time is 24 hours. + "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. "retentionPeriod": "A String", # Required. How long the automated backups should be retained. The only supported value at this time is 3 days. }, "changeStreamConfig": { # Change stream configuration. # If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained. @@ -826,16 +826,16 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations - "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, - "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. + "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`. Use `AddInput` mutations to accumulate new inputs. "max": { # Computes the max of the input values. Allowed input: `Int64` State: same as input # Max aggregator. }, "min": { # Computes the min of the input values. Allowed input: `Int64` State: same as input # Min aggregator. }, - "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. + "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen. "sum": { # Computes the sum of the input values. Allowed input: `Int64` State: same as input # Sum aggregator. }, }, @@ -845,8 +845,8 @@

Method Details

"boolType": { # bool Values of type `Bool` are stored in `Value.bool_value`. # Bool }, "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "raw": { # Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A # Use `Raw` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. }, }, }, @@ -857,11 +857,11 @@

Method Details

"float64Type": { # Float64 Values of type `Float64` are stored in `Value.float_value`. # Float64 }, "int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64 - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "bigEndianBytes": { # Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Order-preserving? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "raw": { # Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A # Use `Raw` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. }, }, }, @@ -873,8 +873,8 @@

Method Details

"valueType": # Object with schema name: Type # The type of the values in a map. }, "stringType": { # String Values of type `String` are stored in `Value.string_value`. # String - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "utf8Bytes": { # UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. }, "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. }, @@ -964,16 +964,16 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations - "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, - "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. + "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`. Use `AddInput` mutations to accumulate new inputs. "max": { # Computes the max of the input values. Allowed input: `Int64` State: same as input # Max aggregator. }, "min": { # Computes the min of the input values. Allowed input: `Int64` State: same as input # Min aggregator. }, - "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. + "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen. "sum": { # Computes the sum of the input values. Allowed input: `Int64` State: same as input # Sum aggregator. }, }, @@ -983,8 +983,8 @@

Method Details

"boolType": { # bool Values of type `Bool` are stored in `Value.bool_value`. # Bool }, "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "raw": { # Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A # Use `Raw` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. }, }, }, @@ -995,11 +995,11 @@

Method Details

"float64Type": { # Float64 Values of type `Float64` are stored in `Value.float_value`. # Float64 }, "int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64 - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "bigEndianBytes": { # Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Order-preserving? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "raw": { # Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A # Use `Raw` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. }, }, }, @@ -1011,8 +1011,8 @@

Method Details

"valueType": # Object with schema name: Type # The type of the values in a map. }, "stringType": { # String Values of type `String` are stored in `Value.string_value`. # String - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "utf8Bytes": { # UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. }, "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. }, @@ -1052,16 +1052,16 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations - "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, - "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. + "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`. Use `AddInput` mutations to accumulate new inputs. "max": { # Computes the max of the input values. Allowed input: `Int64` State: same as input # Max aggregator. }, "min": { # Computes the min of the input values. Allowed input: `Int64` State: same as input # Min aggregator. }, - "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. + "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen. "sum": { # Computes the sum of the input values. Allowed input: `Int64` State: same as input # Sum aggregator. }, }, @@ -1071,8 +1071,8 @@

Method Details

"boolType": { # bool Values of type `Bool` are stored in `Value.bool_value`. # Bool }, "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "raw": { # Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A # Use `Raw` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. }, }, }, @@ -1083,11 +1083,11 @@

Method Details

"float64Type": { # Float64 Values of type `Float64` are stored in `Value.float_value`. # Float64 }, "int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64 - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "bigEndianBytes": { # Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Order-preserving? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "raw": { # Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A # Use `Raw` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. }, }, }, @@ -1099,8 +1099,8 @@

Method Details

"valueType": # Object with schema name: Type # The type of the values in a map. }, "stringType": { # String Values of type `String` are stored in `Value.string_value`. # String - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "utf8Bytes": { # UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. }, "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. }, @@ -1133,7 +1133,7 @@

Method Details

{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. - "frequency": "A String", # Required. How frequently automated backups should occur. The only supported value at this time is 24 hours. + "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. "retentionPeriod": "A String", # Required. How long the automated backups should be retained. The only supported value at this time is 3 days. }, "changeStreamConfig": { # Change stream configuration. # If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained. @@ -1180,16 +1180,16 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations - "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, - "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. + "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`. Use `AddInput` mutations to accumulate new inputs. "max": { # Computes the max of the input values. Allowed input: `Int64` State: same as input # Max aggregator. }, "min": { # Computes the min of the input values. Allowed input: `Int64` State: same as input # Min aggregator. }, - "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. + "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen. "sum": { # Computes the sum of the input values. Allowed input: `Int64` State: same as input # Sum aggregator. }, }, @@ -1199,8 +1199,8 @@

Method Details

"boolType": { # bool Values of type `Bool` are stored in `Value.bool_value`. # Bool }, "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "raw": { # Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A # Use `Raw` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. }, }, }, @@ -1211,11 +1211,11 @@

Method Details

"float64Type": { # Float64 Values of type `Float64` are stored in `Value.float_value`. # Float64 }, "int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64 - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "bigEndianBytes": { # Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Order-preserving? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "raw": { # Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A # Use `Raw` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. }, }, }, @@ -1227,8 +1227,8 @@

Method Details

"valueType": # Object with schema name: Type # The type of the values in a map. }, "stringType": { # String Values of type `String` are stored in `Value.string_value`. # String - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "utf8Bytes": { # UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. }, "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. }, @@ -1280,7 +1280,7 @@

Method Details

{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. - "frequency": "A String", # Required. How frequently automated backups should occur. The only supported value at this time is 24 hours. + "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. "retentionPeriod": "A String", # Required. How long the automated backups should be retained. The only supported value at this time is 3 days. }, "changeStreamConfig": { # Change stream configuration. # If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained. @@ -1327,16 +1327,16 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations - "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, - "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. + "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`. Use `AddInput` mutations to accumulate new inputs. "max": { # Computes the max of the input values. Allowed input: `Int64` State: same as input # Max aggregator. }, "min": { # Computes the min of the input values. Allowed input: `Int64` State: same as input # Min aggregator. }, - "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. + "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen. "sum": { # Computes the sum of the input values. Allowed input: `Int64` State: same as input # Sum aggregator. }, }, @@ -1346,8 +1346,8 @@

Method Details

"boolType": { # bool Values of type `Bool` are stored in `Value.bool_value`. # Bool }, "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "raw": { # Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A # Use `Raw` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. }, }, }, @@ -1358,11 +1358,11 @@

Method Details

"float64Type": { # Float64 Values of type `Float64` are stored in `Value.float_value`. # Float64 }, "int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64 - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "bigEndianBytes": { # Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Order-preserving? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding. "bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "raw": { # Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A # Use `Raw` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. }, }, }, @@ -1374,8 +1374,8 @@

Method Details

"valueType": # Object with schema name: Type # The type of the values in a map. }, "stringType": { # String Values of type `String` are stored in `Value.string_value`. # String - "encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. - "utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. + "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. + "utf8Bytes": { # UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. }, "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. }, diff --git a/docs/dyn/binaryauthorization_v1beta1.projects.html b/docs/dyn/binaryauthorization_v1beta1.projects.html index ac123b3c71..7f244cd5ed 100644 --- a/docs/dyn/binaryauthorization_v1beta1.projects.html +++ b/docs/dyn/binaryauthorization_v1beta1.projects.html @@ -123,7 +123,7 @@

Method Details

"a_key": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, @@ -131,7 +131,7 @@

Method Details

"defaultAdmissionRule": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. # Required. Default admission rule for a cluster without a per-cluster, per- kubernetes-service-account, or per-istio-service-identity admission rule. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, @@ -142,7 +142,7 @@

Method Details

"a_key": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, @@ -151,7 +151,7 @@

Method Details

"a_key": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, @@ -160,7 +160,7 @@

Method Details

"a_key": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, @@ -189,7 +189,7 @@

Method Details

"a_key": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, @@ -197,7 +197,7 @@

Method Details

"defaultAdmissionRule": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. # Required. Default admission rule for a cluster without a per-cluster, per- kubernetes-service-account, or per-istio-service-identity admission rule. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, @@ -208,7 +208,7 @@

Method Details

"a_key": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, @@ -217,7 +217,7 @@

Method Details

"a_key": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, @@ -226,7 +226,7 @@

Method Details

"a_key": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, @@ -253,7 +253,7 @@

Method Details

"a_key": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, @@ -261,7 +261,7 @@

Method Details

"defaultAdmissionRule": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. # Required. Default admission rule for a cluster without a per-cluster, per- kubernetes-service-account, or per-istio-service-identity admission rule. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, @@ -272,7 +272,7 @@

Method Details

"a_key": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, @@ -281,7 +281,7 @@

Method Details

"a_key": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, @@ -290,7 +290,7 @@

Method Details

"a_key": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, diff --git a/docs/dyn/binaryauthorization_v1beta1.systempolicy.html b/docs/dyn/binaryauthorization_v1beta1.systempolicy.html index 4a8758810f..e619240a9d 100644 --- a/docs/dyn/binaryauthorization_v1beta1.systempolicy.html +++ b/docs/dyn/binaryauthorization_v1beta1.systempolicy.html @@ -110,7 +110,7 @@

Method Details

"a_key": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, @@ -118,7 +118,7 @@

Method Details

"defaultAdmissionRule": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. # Required. Default admission rule for a cluster without a per-cluster, per- kubernetes-service-account, or per-istio-service-identity admission rule. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, @@ -129,7 +129,7 @@

Method Details

"a_key": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, @@ -138,7 +138,7 @@

Method Details

"a_key": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, @@ -147,7 +147,7 @@

Method Details

"a_key": { # An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. "enforcementMode": "A String", # Required. The action when a pod creation is denied by the admission rule. "evaluationMode": "A String", # Required. How this admission rule will be evaluated. - "requireAttestationsBy": [ # Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty. + "requireAttestationsBy": [ "A String", ], }, diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index 9aab0c0ea2..f30afa98cf 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -192,12 +192,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -207,6 +236,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -383,6 +436,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -610,6 +664,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -634,8 +689,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -678,12 +755,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -693,6 +799,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -869,6 +999,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -1096,6 +1227,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -1382,12 +1514,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -1397,6 +1558,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -1573,6 +1758,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -1800,6 +1986,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -2011,12 +2198,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -2026,6 +2242,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -2202,6 +2442,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -2429,6 +2670,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -2453,8 +2695,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -2497,12 +2761,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -2512,6 +2805,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -2688,6 +3005,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -2915,6 +3233,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -3201,12 +3520,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -3216,6 +3564,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -3392,6 +3764,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -3619,6 +3992,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -3848,12 +4222,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -3863,6 +4266,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -4039,6 +4466,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -4266,6 +4694,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -4290,8 +4719,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -4334,12 +4785,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -4349,6 +4829,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -4525,6 +5029,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -4752,6 +5257,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -5038,12 +5544,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -5053,6 +5588,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -5229,6 +5788,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -5456,6 +6016,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -5673,12 +6234,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -5688,6 +6278,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -5864,6 +6478,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -6091,6 +6706,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -6115,8 +6731,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -6159,12 +6797,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -6174,6 +6841,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -6350,6 +7041,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -6577,6 +7269,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -6863,12 +7556,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -6878,6 +7600,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -7054,6 +7800,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -7281,6 +8028,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -7503,12 +8251,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -7518,6 +8295,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -7694,6 +8495,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -7921,6 +8723,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -7945,8 +8748,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -7989,12 +8814,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -8004,6 +8858,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -8180,6 +9058,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -8407,6 +9286,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -8693,12 +9573,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -8708,6 +9617,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -8884,6 +9817,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -9111,6 +10045,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -9316,12 +10251,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -9331,6 +10295,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -9507,6 +10495,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -9734,6 +10723,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -9758,8 +10748,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -9802,12 +10814,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -9817,6 +10858,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -9993,6 +11058,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -10220,6 +11286,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -10506,12 +11573,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -10521,6 +11617,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -10697,6 +11817,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -10924,6 +12045,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -11129,12 +12251,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -11144,6 +12295,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -11320,6 +12495,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -11547,6 +12723,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -11571,8 +12748,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -11615,12 +12814,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -11630,6 +12858,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -11806,6 +13058,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -12033,6 +13286,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -12319,12 +13573,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -12334,6 +13617,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -12510,6 +13817,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -12737,6 +14045,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -12942,12 +14251,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -12957,6 +14295,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -13133,6 +14495,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -13360,6 +14723,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -13384,8 +14748,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -13428,12 +14814,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -13443,6 +14858,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -13619,6 +15058,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -13846,6 +15286,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -14132,12 +15573,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -14147,6 +15617,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -14323,6 +15817,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -14550,6 +16045,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index 156c37cfcc..9db73633a6 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -307,12 +307,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -322,6 +351,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -498,6 +551,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -725,6 +779,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -749,8 +804,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -793,12 +870,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -808,6 +914,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -984,6 +1114,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -1211,6 +1342,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -1497,12 +1629,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -1512,6 +1673,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -1688,6 +1873,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -1915,6 +2101,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -2115,12 +2302,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -2130,6 +2346,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -2306,6 +2546,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -2533,6 +2774,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -2557,8 +2799,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -2601,12 +2865,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -2616,6 +2909,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -2792,6 +3109,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -3019,6 +3337,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -3305,12 +3624,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -3320,6 +3668,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -3496,6 +3868,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -3723,6 +4096,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -3923,12 +4297,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -3938,6 +4341,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -4114,6 +4541,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -4341,6 +4769,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -4365,8 +4794,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -4409,12 +4860,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -4424,6 +4904,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -4600,6 +5104,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -4827,6 +5332,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -5113,12 +5619,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -5128,6 +5663,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -5304,6 +5863,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -5531,6 +6091,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -5729,12 +6290,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -5744,6 +6334,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -5920,6 +6534,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -6147,6 +6762,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -6171,8 +6787,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -6215,12 +6853,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -6230,6 +6897,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -6406,6 +7097,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -6633,6 +7325,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -6919,12 +7612,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -6934,6 +7656,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -7110,6 +7856,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -7337,6 +8084,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -7533,12 +8281,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -7548,6 +8325,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -7724,6 +8525,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -7951,6 +8753,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -7975,8 +8778,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -8019,12 +8844,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -8034,6 +8888,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -8210,6 +9088,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -8437,6 +9316,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -8723,12 +9603,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -8738,6 +9647,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -8914,6 +9847,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -9141,6 +10075,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -9337,12 +10272,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -9352,6 +10316,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -9528,6 +10516,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -9755,6 +10744,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -9779,8 +10769,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -9823,12 +10835,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -9838,6 +10879,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -10014,6 +11079,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -10241,6 +11307,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -10527,12 +11594,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -10542,6 +11638,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -10718,6 +11838,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -10945,6 +12066,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -11510,12 +12632,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -11525,6 +12676,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -11701,6 +12876,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -11928,6 +13104,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -11952,8 +13129,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -11996,12 +13195,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -12011,6 +13239,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -12187,6 +13439,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -12414,6 +13667,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -12700,12 +13954,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -12715,6 +13998,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -12891,6 +14198,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -13118,6 +14426,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -13318,12 +14627,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -13333,6 +14671,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -13509,6 +14871,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -13736,6 +15099,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -13760,8 +15124,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -13804,12 +15190,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -13819,6 +15234,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -13995,6 +15434,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -14222,6 +15662,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -14508,12 +15949,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -14523,6 +15993,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -14699,6 +16193,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -14926,6 +16421,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -15126,12 +16622,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -15141,6 +16666,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -15317,6 +16866,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -15544,6 +17094,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -15568,8 +17119,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -15612,12 +17185,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -15627,6 +17229,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -15803,6 +17429,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -16030,6 +17657,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -16316,12 +17944,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -16331,6 +17988,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -16507,6 +18188,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -16734,6 +18416,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -16932,12 +18615,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -16947,6 +18659,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -17123,6 +18859,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -17350,6 +19087,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -17374,8 +19112,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -17418,12 +19178,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -17433,6 +19222,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -17609,6 +19422,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -17836,6 +19650,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -18122,12 +19937,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -18137,6 +19981,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -18313,6 +20181,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -18540,6 +20409,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -18736,12 +20606,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -18751,6 +20650,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -18927,6 +20850,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -19154,6 +21078,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -19178,8 +21103,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -19222,12 +21169,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -19237,6 +21213,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -19413,6 +21413,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -19640,6 +21641,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -19926,12 +21928,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -19941,6 +21972,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -20117,6 +22172,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -20344,6 +22400,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -20540,12 +22597,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -20555,6 +22641,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -20731,6 +22841,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -20958,6 +23069,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -20982,8 +23094,30 @@

Method Details

"openAs": "A String", # How to open a link. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): "url": "A String", # The URL to open. }, + "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat): # If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "items": [ # Required. The list of menu options. + { # An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat): + "disabled": True or False, # Whether the menu option is disabled. Defaults to false. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled. + "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "text": "A String", # Required. The text that identifies or describes the item to users. + }, + ], + }, }, "text": "A String", # The text displayed inside the button. + "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat): }, ], }, @@ -21026,12 +23160,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -21041,6 +23204,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -21217,6 +23404,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -21444,6 +23632,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -21730,12 +23919,41 @@

Method Details

"sectionDividerStyle": "A String", # The divider style between the header, sections and footer. "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + "collapseControl": { # Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat): + "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. + "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button. + }, "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. "widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog. { # A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) @@ -21745,6 +23963,30 @@

Method Details

"widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified. { # The supported widgets that you can include in a column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend) "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget. + "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat): # ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat): + "chips": [ # An array of chips. + { # A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat): + "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". + "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. + "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead. + "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text. + "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. + "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. + "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. + "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). + "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): + "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. + }, + }, + "label": "A String", # The text displayed inside the chip. + "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function. + }, + ], + "layout": "A String", # Specified chip list layout. + }, "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget. "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -21921,6 +24163,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, @@ -22148,6 +24391,7 @@

Method Details

"value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). }, "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat): "text": "A String", # The text that's shown in the widget. }, }, diff --git a/docs/dyn/chromemanagement_v1.customers.reports.html b/docs/dyn/chromemanagement_v1.customers.reports.html index 2cf118d0d2..781f8d8e89 100644 --- a/docs/dyn/chromemanagement_v1.customers.reports.html +++ b/docs/dyn/chromemanagement_v1.customers.reports.html @@ -340,8 +340,8 @@

Method Details

Args: customer: string, Required. Customer id or "my_customer" to use the customer associated to the account making the request. (required) - filter: string, Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id * manifest_versions - orderBy: string, Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id * manifest_versions + filter: string, Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id * manifest_versions * risk_score + orderBy: string, Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id * manifest_versions * risk_score orgUnitId: string, The ID of the organizational unit. pageSize: integer, Maximum number of results to return. Maximum and default are 100. pageToken: string, Token to specify the page of the request to be returned. @@ -369,6 +369,20 @@

Method Details

"permissions": [ # Output only. Permissions of the installed app. "A String", ], + "riskAssessment": { # Risk assessment data about an extension/app. # Output only. If available, the risk assessment data about this extension. + "entries": [ # Individual risk assessments. + { # One risk assessment entry. + "provider": "A String", # The risk assessment provider from which this entry comes from. + "riskAssessment": { # Risk assessment for a Chrome extension. # The details of the provider's risk assessment. + "assessment": "A String", # Risk assessment for the extension. Currently, this is a numerical value, and its interpretation is specific to each risk assessment provider. + "detailsUrl": "A String", # A URL that a user can navigate to for more information about the risk assessment. + "version": "A String", # The version of the extension that this assessment applies to. + }, + "riskLevel": "A String", # The bucketed risk level for the risk assessment. + }, + ], + "overallRiskLevel": "A String", # Overall assessed risk level across all entries. This will be the highest risk level from all entries. + }, }, ], "nextPageToken": "A String", # Token to specify the next page of the request. diff --git a/docs/dyn/cloudbilling_v1.billingAccounts.html b/docs/dyn/cloudbilling_v1.billingAccounts.html index db99979de4..a9c2fc3d3c 100644 --- a/docs/dyn/cloudbilling_v1.billingAccounts.html +++ b/docs/dyn/cloudbilling_v1.billingAccounts.html @@ -129,6 +129,7 @@

Method Details

The object takes the form of: { # A billing account in the [Google Cloud Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects. + "currencyCode": "A String", # Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as `USD`. Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account. "displayName": "A String", # The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console. "masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. "name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. @@ -146,6 +147,7 @@

Method Details

An object of the form: { # A billing account in the [Google Cloud Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects. + "currencyCode": "A String", # Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as `USD`. Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account. "displayName": "A String", # The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console. "masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. "name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. @@ -169,6 +171,7 @@

Method Details

An object of the form: { # A billing account in the [Google Cloud Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects. + "currencyCode": "A String", # Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as `USD`. Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account. "displayName": "A String", # The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console. "masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. "name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. @@ -245,6 +248,7 @@

Method Details

{ # Response message for `ListBillingAccounts`. "billingAccounts": [ # A list of billing accounts. { # A billing account in the [Google Cloud Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects. + "currencyCode": "A String", # Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as `USD`. Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account. "displayName": "A String", # The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console. "masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. "name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. @@ -292,6 +296,7 @@

Method Details

An object of the form: { # A billing account in the [Google Cloud Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects. + "currencyCode": "A String", # Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as `USD`. Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account. "displayName": "A String", # The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console. "masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. "name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. @@ -310,6 +315,7 @@

Method Details

The object takes the form of: { # A billing account in the [Google Cloud Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects. + "currencyCode": "A String", # Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as `USD`. Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account. "displayName": "A String", # The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console. "masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. "name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. @@ -327,6 +333,7 @@

Method Details

An object of the form: { # A billing account in the [Google Cloud Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects. + "currencyCode": "A String", # Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as `USD`. Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account. "displayName": "A String", # The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console. "masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. "name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. diff --git a/docs/dyn/cloudbilling_v1.billingAccounts.subAccounts.html b/docs/dyn/cloudbilling_v1.billingAccounts.subAccounts.html index ee57bb7146..f2792d5482 100644 --- a/docs/dyn/cloudbilling_v1.billingAccounts.subAccounts.html +++ b/docs/dyn/cloudbilling_v1.billingAccounts.subAccounts.html @@ -102,6 +102,7 @@

Method Details

The object takes the form of: { # A billing account in the [Google Cloud Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects. + "currencyCode": "A String", # Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as `USD`. Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account. "displayName": "A String", # The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console. "masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. "name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. @@ -118,6 +119,7 @@

Method Details

An object of the form: { # A billing account in the [Google Cloud Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects. + "currencyCode": "A String", # Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as `USD`. Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account. "displayName": "A String", # The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console. "masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. "name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. @@ -146,6 +148,7 @@

Method Details

{ # Response message for `ListBillingAccounts`. "billingAccounts": [ # A list of billing accounts. { # A billing account in the [Google Cloud Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects. + "currencyCode": "A String", # Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as `USD`. Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account. "displayName": "A String", # The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console. "masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. "name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. diff --git a/docs/dyn/cloudbilling_v1.organizations.billingAccounts.html b/docs/dyn/cloudbilling_v1.organizations.billingAccounts.html index b254036f2a..2e390bfb2e 100644 --- a/docs/dyn/cloudbilling_v1.organizations.billingAccounts.html +++ b/docs/dyn/cloudbilling_v1.organizations.billingAccounts.html @@ -105,6 +105,7 @@

Method Details

The object takes the form of: { # A billing account in the [Google Cloud Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects. + "currencyCode": "A String", # Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as `USD`. Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account. "displayName": "A String", # The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console. "masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. "name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. @@ -121,6 +122,7 @@

Method Details

An object of the form: { # A billing account in the [Google Cloud Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects. + "currencyCode": "A String", # Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as `USD`. Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account. "displayName": "A String", # The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console. "masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. "name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. @@ -149,6 +151,7 @@

Method Details

{ # Response message for `ListBillingAccounts`. "billingAccounts": [ # A list of billing accounts. { # A billing account in the [Google Cloud Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects. + "currencyCode": "A String", # Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as `USD`. Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account. "displayName": "A String", # The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console. "masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. "name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. @@ -190,6 +193,7 @@

Method Details

An object of the form: { # A billing account in the [Google Cloud Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects. + "currencyCode": "A String", # Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as `USD`. Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account. "displayName": "A String", # The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console. "masterBillingAccount": "A String", # If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. "name": "A String", # Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. diff --git a/docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html b/docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html index c440502c33..0af26c82a7 100644 --- a/docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html +++ b/docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html @@ -273,7 +273,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Request message for CloudChannelService.ChangeParametersRequest. +{ # Request message for CloudChannelService.ChangeParameters. "parameters": [ # Required. Entitlement parameters to update. You can only change editable parameters. To view the available Parameters for a request, refer to the Offer.parameter_definitions from the desired offer. { # Definition for extended entitlement parameters. "editable": True or False, # Output only. Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active. diff --git a/docs/dyn/cloudchannel_v1.accounts.html b/docs/dyn/cloudchannel_v1.accounts.html index 4852662654..a8bc36303c 100644 --- a/docs/dyn/cloudchannel_v1.accounts.html +++ b/docs/dyn/cloudchannel_v1.accounts.html @@ -111,8 +111,8 @@

Instance Methods

close()

Close httplib2 connections.

- listSubscribers(account, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.

+ listSubscribers(account, integrator=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.

listSubscribers_next()

Retrieves the next page of results.

@@ -130,10 +130,10 @@

Instance Methods

Retrieves the next page of results.

register(account, body=None, x__xgafv=None)

-

Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.

+

Registers a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or integrator. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.

unregister(account, body=None, x__xgafv=None)

-

Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.

+

Unregisters a service account with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.

Method Details

checkCloudIdentityAccountsExist(parent, body=None, x__xgafv=None) @@ -177,11 +177,12 @@

Method Details

- listSubscribers(account, pageSize=None, pageToken=None, x__xgafv=None) -
Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.
+    listSubscribers(account, integrator=None, pageSize=None, pageToken=None, x__xgafv=None)
+  
Lists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.
 
 Args:
-  account: string, Optional. Resource name of the account. (required)
+  account: string, Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset. (required)
+  integrator: string, Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.
   pageSize: integer, Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000.
   pageToken: string, Optional. A page token, received from a previous `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -530,14 +531,16 @@ 

Method Details

register(account, body=None, x__xgafv=None) -
Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.
+  
Registers a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or integrator. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.
 
 Args:
-  account: string, Optional. Resource name of the account. (required)
+  account: string, Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request Message for RegisterSubscriber.
+  "account": "A String", # Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.
+  "integrator": "A String", # Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.
   "serviceAccount": "A String", # Required. Service account that provides subscriber access to the registered topic.
 }
 
@@ -556,14 +559,16 @@ 

Method Details

unregister(account, body=None, x__xgafv=None) -
Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.
+  
Unregisters a service account with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.
 
 Args:
-  account: string, Optional. Resource name of the account. (required)
+  account: string, Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request Message for UnregisterSubscriber.
+  "account": "A String", # Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.
+  "integrator": "A String", # Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.
   "serviceAccount": "A String", # Required. Service account to unregister from subscriber access to the topic.
 }
 
diff --git a/docs/dyn/cloudchannel_v1.accounts.skuGroups.billableSkus.html b/docs/dyn/cloudchannel_v1.accounts.skuGroups.billableSkus.html
index 53c30e5b96..1d3084e727 100644
--- a/docs/dyn/cloudchannel_v1.accounts.skuGroups.billableSkus.html
+++ b/docs/dyn/cloudchannel_v1.accounts.skuGroups.billableSkus.html
@@ -96,7 +96,7 @@ 

Method Details

Args: parent: string, Required. Resource name of the SKU group. Format: accounts/{account}/skuGroups/{sku_group}. (required) pageSize: integer, Optional. The maximum number of SKUs to return. The service may return fewer than this value. If unspecified, returns a maximum of 100000 SKUs. The maximum value is 100000; values above 100000 will be coerced to 100000. - pageToken: string, Optional. A token identifying a page of results beyond the first page. Obtained through ListSkuGroupBillableSkus.next_page_token of the previous CloudChannelService.ListSkuGroupBillableSkus call. + pageToken: string, Optional. A token identifying a page of results beyond the first page. Obtained through ListSkuGroupBillableSkusResponse.next_page_token of the previous CloudChannelService.ListSkuGroupBillableSkus call. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -114,7 +114,7 @@

Method Details

"skuDisplayName": "A String", # Unique human readable name for the SKU. }, ], - "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListSkuGroupBillableSkus.page_token to obtain that page. + "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListSkuGroupBillableSkusRequest.page_token to obtain that page. }
diff --git a/docs/dyn/cloudchannel_v1.accounts.skuGroups.html b/docs/dyn/cloudchannel_v1.accounts.skuGroups.html index 8a066372f8..279c82a8ad 100644 --- a/docs/dyn/cloudchannel_v1.accounts.skuGroups.html +++ b/docs/dyn/cloudchannel_v1.accounts.skuGroups.html @@ -101,7 +101,7 @@

Method Details

Args: parent: string, Required. The resource name of the account from which to list SKU groups. Parent uses the format: accounts/{account}. (required) pageSize: integer, Optional. The maximum number of SKU groups to return. The service may return fewer than this value. If unspecified, returns a maximum of 1000 SKU groups. The maximum value is 1000; values above 1000 will be coerced to 1000. - pageToken: string, Optional. A token identifying a page of results beyond the first page. Obtained through ListSkuGroups.next_page_token of the previous CloudChannelService.ListSkuGroups call. + pageToken: string, Optional. A token identifying a page of results beyond the first page. Obtained through ListSkuGroupsResponse.next_page_token of the previous CloudChannelService.ListSkuGroups call. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -111,7 +111,7 @@

Method Details

An object of the form: { # Response message for ListSkuGroups. - "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListSkuGroups.page_token to obtain that page. + "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListSkuGroupsRequest.page_token to obtain that page. "skuGroups": [ # The list of SKU groups requested. { # Represents the SKU group information. "displayName": "A String", # Unique human readable identifier for the SKU group. diff --git a/docs/dyn/cloudchannel_v1.html b/docs/dyn/cloudchannel_v1.html index 22cbcd31f4..aa51f74b7e 100644 --- a/docs/dyn/cloudchannel_v1.html +++ b/docs/dyn/cloudchannel_v1.html @@ -79,6 +79,11 @@

Instance Methods

Returns the accounts Resource.

+

+ integrators() +

+

Returns the integrators Resource.

+

operations()

diff --git a/docs/dyn/cloudchannel_v1.integrators.html b/docs/dyn/cloudchannel_v1.integrators.html index 123dbfae9e..52045ddf02 100644 --- a/docs/dyn/cloudchannel_v1.integrators.html +++ b/docs/dyn/cloudchannel_v1.integrators.html @@ -79,16 +79,16 @@

Instance Methods

Close httplib2 connections.

listSubscribers(integrator, account=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.

+

Lists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.

listSubscribers_next()

Retrieves the next page of results.

- register(integrator, account=None, serviceAccount=None, x__xgafv=None)

-

Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.

+ registerSubscriber(integrator, body=None, x__xgafv=None)

+

Registers a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or integrator. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.

- unregister(integrator, account=None, serviceAccount=None, x__xgafv=None)

-

Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.

+ unregisterSubscriber(integrator, body=None, x__xgafv=None)

+

Unregisters a service account with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.

Method Details

close() @@ -97,11 +97,11 @@

Method Details

listSubscribers(integrator, account=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.
+  
Lists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.
 
 Args:
-  integrator: string, Optional. Resource name of the integrator. (required)
-  account: string, Optional. Resource name of the account.
+  integrator: string, Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset. (required)
+  account: string, Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.
   pageSize: integer, Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000.
   pageToken: string, Optional. A page token, received from a previous `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -136,13 +136,20 @@ 

Method Details

- register(integrator, account=None, serviceAccount=None, x__xgafv=None) -
Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.
+    registerSubscriber(integrator, body=None, x__xgafv=None)
+  
Registers a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or integrator. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.
 
 Args:
-  integrator: string, Optional. Resource name of the integrator. (required)
-  account: string, Optional. Resource name of the account.
-  serviceAccount: string, Required. Service account that provides subscriber access to the registered topic.
+  integrator: string, Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request Message for RegisterSubscriber.
+  "account": "A String", # Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.
+  "integrator": "A String", # Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.
+  "serviceAccount": "A String", # Required. Service account that provides subscriber access to the registered topic.
+}
+
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -157,13 +164,20 @@ 

Method Details

- unregister(integrator, account=None, serviceAccount=None, x__xgafv=None) -
Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.
+    unregisterSubscriber(integrator, body=None, x__xgafv=None)
+  
Unregisters a service account with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.
 
 Args:
-  integrator: string, Optional. Resource name of the integrator. (required)
-  account: string, Optional. Resource name of the account.
-  serviceAccount: string, Required. Service account to unregister from subscriber access to the topic.
+  integrator: string, Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request Message for UnregisterSubscriber.
+  "account": "A String", # Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.
+  "integrator": "A String", # Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.
+  "serviceAccount": "A String", # Required. Service account to unregister from subscriber access to the topic.
+}
+
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html b/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html
index 934ce85363..e4b1649ae9 100644
--- a/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html
+++ b/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html
@@ -82,6 +82,12 @@ 

Instance Methods

close()

Close httplib2 connections.

+

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

+

Creates a new customer.

+

+ delete(name, x__xgafv=None)

+

Delete details of a single customer

get(name, x__xgafv=None)

Gets details of a single customer

@@ -91,12 +97,86 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

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

+

Update details of a single customer

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, customerId=None, x__xgafv=None) +
Creates a new customer.
+
+Args:
+  parent: string, Required. Parent resource Format: `organizations/{organization}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Contains metadata around a Cloud Controls Partner Customer
+  "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps
+    "onboardingSteps": [ # List of customer onboarding steps
+      { # Container for customer onboarding information
+        "completionState": "A String", # Output only. Current state of the step
+        "completionTime": "A String", # The completion time of the onboarding step
+        "startTime": "A String", # The starting time of the onboarding step
+        "step": "A String", # The onboarding step
+      },
+    ],
+  },
+  "displayName": "A String", # Required. Display name for the customer
+  "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded
+  "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
+  "organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com"
+}
+
+  customerId: string, Required. The customer id to use for the customer, which will become the final component of the customer's resource name. The specified value must be a valid Google cloud organization id.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains metadata around a Cloud Controls Partner Customer
+  "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps
+    "onboardingSteps": [ # List of customer onboarding steps
+      { # Container for customer onboarding information
+        "completionState": "A String", # Output only. Current state of the step
+        "completionTime": "A String", # The completion time of the onboarding step
+        "startTime": "A String", # The starting time of the onboarding step
+        "step": "A String", # The onboarding step
+      },
+    ],
+  },
+  "displayName": "A String", # Required. Display name for the customer
+  "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded
+  "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
+  "organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com"
+}
+
+ +
+ delete(name, x__xgafv=None) +
Delete details of a single customer
+
+Args:
+  name: string, Required. name of the resource to be deleted format: name=organizations/*/locations/*/customers/* (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
get(name, x__xgafv=None)
Gets details of a single customer
@@ -125,6 +205,7 @@ 

Method Details

"displayName": "A String", # Required. Display name for the customer "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` + "organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com" }
@@ -162,6 +243,7 @@

Method Details

"displayName": "A String", # Required. Display name for the customer "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` + "organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com" }, ], "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -185,4 +267,57 @@

Method Details

+
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Update details of a single customer
+
+Args:
+  name: string, Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Contains metadata around a Cloud Controls Partner Customer
+  "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps
+    "onboardingSteps": [ # List of customer onboarding steps
+      { # Container for customer onboarding information
+        "completionState": "A String", # Output only. Current state of the step
+        "completionTime": "A String", # The completion time of the onboarding step
+        "startTime": "A String", # The starting time of the onboarding step
+        "step": "A String", # The onboarding step
+      },
+    ],
+  },
+  "displayName": "A String", # Required. Display name for the customer
+  "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded
+  "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
+  "organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com"
+}
+
+  updateMask: string, Optional. The list of fields to update
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains metadata around a Cloud Controls Partner Customer
+  "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps
+    "onboardingSteps": [ # List of customer onboarding steps
+      { # Container for customer onboarding information
+        "completionState": "A String", # Output only. Current state of the step
+        "completionTime": "A String", # The completion time of the onboarding step
+        "startTime": "A String", # The starting time of the onboarding step
+        "step": "A String", # The onboarding step
+      },
+    ],
+  },
+  "displayName": "A String", # Required. Display name for the customer
+  "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded
+  "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
+  "organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com"
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html b/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html index 05d06a649d..22957ca7bf 100644 --- a/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html +++ b/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html @@ -82,6 +82,12 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Creates a new customer.

+

+ delete(name, x__xgafv=None)

+

Delete details of a single customer

get(name, x__xgafv=None)

Gets details of a single customer

@@ -91,12 +97,86 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

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

+

Update details of a single customer

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, customerId=None, x__xgafv=None) +
Creates a new customer.
+
+Args:
+  parent: string, Required. Parent resource Format: `organizations/{organization}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Contains metadata around a Cloud Controls Partner Customer
+  "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps
+    "onboardingSteps": [ # List of customer onboarding steps
+      { # Container for customer onboarding information
+        "completionState": "A String", # Output only. Current state of the step
+        "completionTime": "A String", # The completion time of the onboarding step
+        "startTime": "A String", # The starting time of the onboarding step
+        "step": "A String", # The onboarding step
+      },
+    ],
+  },
+  "displayName": "A String", # Required. Display name for the customer
+  "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded
+  "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
+  "organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com"
+}
+
+  customerId: string, Required. The customer id to use for the customer, which will become the final component of the customer's resource name. The specified value must be a valid Google cloud organization id.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains metadata around a Cloud Controls Partner Customer
+  "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps
+    "onboardingSteps": [ # List of customer onboarding steps
+      { # Container for customer onboarding information
+        "completionState": "A String", # Output only. Current state of the step
+        "completionTime": "A String", # The completion time of the onboarding step
+        "startTime": "A String", # The starting time of the onboarding step
+        "step": "A String", # The onboarding step
+      },
+    ],
+  },
+  "displayName": "A String", # Required. Display name for the customer
+  "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded
+  "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
+  "organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com"
+}
+
+ +
+ delete(name, x__xgafv=None) +
Delete details of a single customer
+
+Args:
+  name: string, Required. name of the resource to be deleted format: name=organizations/*/locations/*/customers/* (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
get(name, x__xgafv=None)
Gets details of a single customer
@@ -125,6 +205,7 @@ 

Method Details

"displayName": "A String", # Required. Display name for the customer "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` + "organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com" }
@@ -162,6 +243,7 @@

Method Details

"displayName": "A String", # Required. Display name for the customer "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` + "organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com" }, ], "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -185,4 +267,57 @@

Method Details

+
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Update details of a single customer
+
+Args:
+  name: string, Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Contains metadata around a Cloud Controls Partner Customer
+  "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps
+    "onboardingSteps": [ # List of customer onboarding steps
+      { # Container for customer onboarding information
+        "completionState": "A String", # Output only. Current state of the step
+        "completionTime": "A String", # The completion time of the onboarding step
+        "startTime": "A String", # The starting time of the onboarding step
+        "step": "A String", # The onboarding step
+      },
+    ],
+  },
+  "displayName": "A String", # Required. Display name for the customer
+  "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded
+  "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
+  "organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com"
+}
+
+  updateMask: string, Optional. The list of fields to update
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains metadata around a Cloud Controls Partner Customer
+  "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps
+    "onboardingSteps": [ # List of customer onboarding steps
+      { # Container for customer onboarding information
+        "completionState": "A String", # Output only. Current state of the step
+        "completionTime": "A String", # The completion time of the onboarding step
+        "startTime": "A String", # The starting time of the onboarding step
+        "step": "A String", # The onboarding step
+      },
+    ],
+  },
+  "displayName": "A String", # Required. Display name for the customer
+  "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded
+  "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
+  "organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com"
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html index 209429f3a0..4a0a7f2bc6 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html @@ -239,6 +239,12 @@

Method Details

"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service. "httpRoute": "A String", # Required. Name of the Gateway API HTTPRoute. "podSelectorLabel": "A String", # Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources. + "routeDestinations": { # Information about route destinations for the Gateway API service mesh. # Optional. Route destinations allow configuring the Gateway API HTTPRoute to be deployed to additional clusters. This option is available for multi-cluster service mesh set ups that require the route to exist in the clusters that call the service. If unspecified, the HTTPRoute will only be deployed to the Target cluster. + "destinationIds": [ # Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and "@self" to include the Target cluster. + "A String", + ], + "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. + }, "routeUpdateWaitTime": "A String", # Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time. "service": "A String", # Required. Name of the Kubernetes Service. "stableCutbackDuration": "A String", # Optional. The amount of time to migrate traffic back from the canary Service to the original Service during the stable phase deployment. If specified, must be between 15s and 3600s. If unspecified, there is no cutback time. @@ -463,6 +469,12 @@

Method Details

"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service. "httpRoute": "A String", # Required. Name of the Gateway API HTTPRoute. "podSelectorLabel": "A String", # Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources. + "routeDestinations": { # Information about route destinations for the Gateway API service mesh. # Optional. Route destinations allow configuring the Gateway API HTTPRoute to be deployed to additional clusters. This option is available for multi-cluster service mesh set ups that require the route to exist in the clusters that call the service. If unspecified, the HTTPRoute will only be deployed to the Target cluster. + "destinationIds": [ # Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and "@self" to include the Target cluster. + "A String", + ], + "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. + }, "routeUpdateWaitTime": "A String", # Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time. "service": "A String", # Required. Name of the Kubernetes Service. "stableCutbackDuration": "A String", # Optional. The amount of time to migrate traffic back from the canary Service to the original Service during the stable phase deployment. If specified, must be between 15s and 3600s. If unspecified, there is no cutback time. @@ -670,6 +682,12 @@

Method Details

"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service. "httpRoute": "A String", # Required. Name of the Gateway API HTTPRoute. "podSelectorLabel": "A String", # Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources. + "routeDestinations": { # Information about route destinations for the Gateway API service mesh. # Optional. Route destinations allow configuring the Gateway API HTTPRoute to be deployed to additional clusters. This option is available for multi-cluster service mesh set ups that require the route to exist in the clusters that call the service. If unspecified, the HTTPRoute will only be deployed to the Target cluster. + "destinationIds": [ # Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and "@self" to include the Target cluster. + "A String", + ], + "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. + }, "routeUpdateWaitTime": "A String", # Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time. "service": "A String", # Required. Name of the Kubernetes Service. "stableCutbackDuration": "A String", # Optional. The amount of time to migrate traffic back from the canary Service to the original Service during the stable phase deployment. If specified, must be between 15s and 3600s. If unspecified, there is no cutback time. @@ -838,6 +856,12 @@

Method Details

"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service. "httpRoute": "A String", # Required. Name of the Gateway API HTTPRoute. "podSelectorLabel": "A String", # Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources. + "routeDestinations": { # Information about route destinations for the Gateway API service mesh. # Optional. Route destinations allow configuring the Gateway API HTTPRoute to be deployed to additional clusters. This option is available for multi-cluster service mesh set ups that require the route to exist in the clusters that call the service. If unspecified, the HTTPRoute will only be deployed to the Target cluster. + "destinationIds": [ # Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and "@self" to include the Target cluster. + "A String", + ], + "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. + }, "routeUpdateWaitTime": "A String", # Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time. "service": "A String", # Required. Name of the Kubernetes Service. "stableCutbackDuration": "A String", # Optional. The amount of time to migrate traffic back from the canary Service to the original Service during the stable phase deployment. If specified, must be between 15s and 3600s. If unspecified, there is no cutback time. diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html index 00dbb5dd87..c306b0420e 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html @@ -303,6 +303,12 @@

Method Details

"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service. "httpRoute": "A String", # Required. Name of the Gateway API HTTPRoute. "podSelectorLabel": "A String", # Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources. + "routeDestinations": { # Information about route destinations for the Gateway API service mesh. # Optional. Route destinations allow configuring the Gateway API HTTPRoute to be deployed to additional clusters. This option is available for multi-cluster service mesh set ups that require the route to exist in the clusters that call the service. If unspecified, the HTTPRoute will only be deployed to the Target cluster. + "destinationIds": [ # Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and "@self" to include the Target cluster. + "A String", + ], + "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. + }, "routeUpdateWaitTime": "A String", # Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time. "service": "A String", # Required. Name of the Kubernetes Service. "stableCutbackDuration": "A String", # Optional. The amount of time to migrate traffic back from the canary Service to the original Service during the stable phase deployment. If specified, must be between 15s and 3600s. If unspecified, there is no cutback time. @@ -393,6 +399,22 @@

Method Details

"anthosCluster": { # Information specifying an Anthos Cluster. # Optional. Information specifying an Anthos Cluster. "membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`. }, + "associatedEntities": { # Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. + "a_key": { # Information about entities associated with a `Target`. + "anthosClusters": [ # Optional. Information specifying Anthos clusters as associated entities. + { # Information specifying an Anthos Cluster. + "membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`. + }, + ], + "gkeClusters": [ # Optional. Information specifying GKE clusters as associated entities. + { # Information specifying a GKE Cluster. + "cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`. + "internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). + "proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server. + }, + ], + }, + }, "createTime": "A String", # Output only. Time at which the `Target` was created. "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target. "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`. @@ -663,6 +685,12 @@

Method Details

"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service. "httpRoute": "A String", # Required. Name of the Gateway API HTTPRoute. "podSelectorLabel": "A String", # Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources. + "routeDestinations": { # Information about route destinations for the Gateway API service mesh. # Optional. Route destinations allow configuring the Gateway API HTTPRoute to be deployed to additional clusters. This option is available for multi-cluster service mesh set ups that require the route to exist in the clusters that call the service. If unspecified, the HTTPRoute will only be deployed to the Target cluster. + "destinationIds": [ # Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and "@self" to include the Target cluster. + "A String", + ], + "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. + }, "routeUpdateWaitTime": "A String", # Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time. "service": "A String", # Required. Name of the Kubernetes Service. "stableCutbackDuration": "A String", # Optional. The amount of time to migrate traffic back from the canary Service to the original Service during the stable phase deployment. If specified, must be between 15s and 3600s. If unspecified, there is no cutback time. @@ -753,6 +781,22 @@

Method Details

"anthosCluster": { # Information specifying an Anthos Cluster. # Optional. Information specifying an Anthos Cluster. "membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`. }, + "associatedEntities": { # Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. + "a_key": { # Information about entities associated with a `Target`. + "anthosClusters": [ # Optional. Information specifying Anthos clusters as associated entities. + { # Information specifying an Anthos Cluster. + "membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`. + }, + ], + "gkeClusters": [ # Optional. Information specifying GKE clusters as associated entities. + { # Information specifying a GKE Cluster. + "cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`. + "internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). + "proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server. + }, + ], + }, + }, "createTime": "A String", # Output only. Time at which the `Target` was created. "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target. "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`. @@ -998,6 +1042,12 @@

Method Details

"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service. "httpRoute": "A String", # Required. Name of the Gateway API HTTPRoute. "podSelectorLabel": "A String", # Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources. + "routeDestinations": { # Information about route destinations for the Gateway API service mesh. # Optional. Route destinations allow configuring the Gateway API HTTPRoute to be deployed to additional clusters. This option is available for multi-cluster service mesh set ups that require the route to exist in the clusters that call the service. If unspecified, the HTTPRoute will only be deployed to the Target cluster. + "destinationIds": [ # Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and "@self" to include the Target cluster. + "A String", + ], + "propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. + }, "routeUpdateWaitTime": "A String", # Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time. "service": "A String", # Required. Name of the Kubernetes Service. "stableCutbackDuration": "A String", # Optional. The amount of time to migrate traffic back from the canary Service to the original Service during the stable phase deployment. If specified, must be between 15s and 3600s. If unspecified, there is no cutback time. @@ -1088,6 +1138,22 @@

Method Details

"anthosCluster": { # Information specifying an Anthos Cluster. # Optional. Information specifying an Anthos Cluster. "membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`. }, + "associatedEntities": { # Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. + "a_key": { # Information about entities associated with a `Target`. + "anthosClusters": [ # Optional. Information specifying Anthos clusters as associated entities. + { # Information specifying an Anthos Cluster. + "membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`. + }, + ], + "gkeClusters": [ # Optional. Information specifying GKE clusters as associated entities. + { # Information specifying a GKE Cluster. + "cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`. + "internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). + "proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server. + }, + ], + }, + }, "createTime": "A String", # Output only. Time at which the `Target` was created. "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target. "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`. diff --git a/docs/dyn/clouddeploy_v1.projects.locations.targets.html b/docs/dyn/clouddeploy_v1.projects.locations.targets.html index 7bfa259ca6..6f5701b11d 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.targets.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.targets.html @@ -126,6 +126,22 @@

Method Details

"anthosCluster": { # Information specifying an Anthos Cluster. # Optional. Information specifying an Anthos Cluster. "membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`. }, + "associatedEntities": { # Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. + "a_key": { # Information about entities associated with a `Target`. + "anthosClusters": [ # Optional. Information specifying Anthos clusters as associated entities. + { # Information specifying an Anthos Cluster. + "membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`. + }, + ], + "gkeClusters": [ # Optional. Information specifying GKE clusters as associated entities. + { # Information specifying a GKE Cluster. + "cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`. + "internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). + "proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server. + }, + ], + }, + }, "createTime": "A String", # Output only. Time at which the `Target` was created. "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target. "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`. @@ -271,6 +287,22 @@

Method Details

"anthosCluster": { # Information specifying an Anthos Cluster. # Optional. Information specifying an Anthos Cluster. "membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`. }, + "associatedEntities": { # Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. + "a_key": { # Information about entities associated with a `Target`. + "anthosClusters": [ # Optional. Information specifying Anthos clusters as associated entities. + { # Information specifying an Anthos Cluster. + "membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`. + }, + ], + "gkeClusters": [ # Optional. Information specifying GKE clusters as associated entities. + { # Information specifying a GKE Cluster. + "cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`. + "internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). + "proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server. + }, + ], + }, + }, "createTime": "A String", # Output only. Time at which the `Target` was created. "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target. "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`. @@ -401,6 +433,22 @@

Method Details

"anthosCluster": { # Information specifying an Anthos Cluster. # Optional. Information specifying an Anthos Cluster. "membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`. }, + "associatedEntities": { # Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. + "a_key": { # Information about entities associated with a `Target`. + "anthosClusters": [ # Optional. Information specifying Anthos clusters as associated entities. + { # Information specifying an Anthos Cluster. + "membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`. + }, + ], + "gkeClusters": [ # Optional. Information specifying GKE clusters as associated entities. + { # Information specifying a GKE Cluster. + "cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`. + "internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). + "proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server. + }, + ], + }, + }, "createTime": "A String", # Output only. Time at which the `Target` was created. "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target. "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`. @@ -490,6 +538,22 @@

Method Details

"anthosCluster": { # Information specifying an Anthos Cluster. # Optional. Information specifying an Anthos Cluster. "membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`. }, + "associatedEntities": { # Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. + "a_key": { # Information about entities associated with a `Target`. + "anthosClusters": [ # Optional. Information specifying Anthos clusters as associated entities. + { # Information specifying an Anthos Cluster. + "membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`. + }, + ], + "gkeClusters": [ # Optional. Information specifying GKE clusters as associated entities. + { # Information specifying a GKE Cluster. + "cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`. + "internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). + "proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server. + }, + ], + }, + }, "createTime": "A String", # Output only. Time at which the `Target` was created. "customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target. "customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`. diff --git a/docs/dyn/cloudidentity_v1beta1.html b/docs/dyn/cloudidentity_v1beta1.html index 615fb31611..92d1607583 100644 --- a/docs/dyn/cloudidentity_v1beta1.html +++ b/docs/dyn/cloudidentity_v1beta1.html @@ -104,6 +104,11 @@

Instance Methods

Returns the orgUnits Resource.

+

+ policies() +

+

Returns the policies Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/cloudidentity_v1beta1.policies.html b/docs/dyn/cloudidentity_v1beta1.policies.html new file mode 100644 index 0000000000..c1e9f7d3e6 --- /dev/null +++ b/docs/dyn/cloudidentity_v1beta1.policies.html @@ -0,0 +1,182 @@ + + + +

Cloud Identity API . policies

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Get a Policy

+

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

+

List Policies

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Get a Policy
+
+Args:
+  name: string, Required. The name of the policy to retrieve. Format: "policies/{policy}". (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A Policy resource binds an instance of a single Setting with the scope of a PolicyQuery. The Setting instance will be applied to all entities that satisfy the query.
+  "customer": "A String", # Immutable. Customer that the Policy belongs to. The value is in the format 'customers/{customerId}'. The `customerId` must begin with "C" To find your customer ID in Admin Console see https://support.google.com/a/answer/10070793.
+  "name": "A String", # Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}.
+  "policyQuery": { # PolicyQuery # Required. The PolicyQuery the Setting applies to.
+    "group": "A String", # Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string.
+    "orgUnit": "A String", # Required. Immutable. Non-empty default. The OrgUnit the query applies to. This field is only set if there is a single value for org_unit that satisfies all clauses of the query.
+    "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use.
+    "sortOrder": 3.14, # Output only. The decimal sort order of this PolicyQuery. The value is relative to all other policies with the same setting type within the whole customer. (there are no duplicates within this set).
+  },
+  "setting": { # Setting # Required. The Setting configured by this Policy.
+    "type": "A String", # Required. Immutable. The type of the Setting. .
+    "value": { # Required. The value of the Setting.
+      "a_key": "", # Properties of the object.
+    },
+  },
+  "type": "A String", # Output only. The type of the policy.
+}
+
+ +
+ list(filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
List Policies
+
+Args:
+  filter: string, Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.name = 'settings/gmail.*' Policies can be filtered by setting type with this expression: setting.name = '*.service_status' A maximum of one of the above setting.name clauses can be used. Policies can be filtered by customer with this expression: customer = "customers/{customer}" Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. A maximum of one customer clause can be used. The above clauses can only be combined together in a single filter expression with the AND operator.
+  pageSize: integer, Optional. The maximum number of results to return. The service may return fewer than this value. If omitted (or defaulted to zero) the server will default to 50. The maximum allowed value is 100, though requests with page_size greater than that will be interpreted as 100.
+  pageToken: string, Optional. The pagination token received from a prior call to PoliciesService.ListPolicies to retrieve the next page of results. When paginating, all other parameters provided to `ListPoliciesRequest` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for PoliciesService.ListPolicies.
+  "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If this field is empty, there are no subsequent pages.
+  "policies": [ # The results
+    { # A Policy resource binds an instance of a single Setting with the scope of a PolicyQuery. The Setting instance will be applied to all entities that satisfy the query.
+      "customer": "A String", # Immutable. Customer that the Policy belongs to. The value is in the format 'customers/{customerId}'. The `customerId` must begin with "C" To find your customer ID in Admin Console see https://support.google.com/a/answer/10070793.
+      "name": "A String", # Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}.
+      "policyQuery": { # PolicyQuery # Required. The PolicyQuery the Setting applies to.
+        "group": "A String", # Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string.
+        "orgUnit": "A String", # Required. Immutable. Non-empty default. The OrgUnit the query applies to. This field is only set if there is a single value for org_unit that satisfies all clauses of the query.
+        "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use.
+        "sortOrder": 3.14, # Output only. The decimal sort order of this PolicyQuery. The value is relative to all other policies with the same setting type within the whole customer. (there are no duplicates within this set).
+      },
+      "setting": { # Setting # Required. The Setting configured by this Policy.
+        "type": "A String", # Required. Immutable. The type of the Setting. .
+        "value": { # Required. The value of the Setting.
+          "a_key": "", # Properties of the object.
+        },
+      },
+      "type": "A String", # Output only. The type of the policy.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/cloudsearch_v1.query.html b/docs/dyn/cloudsearch_v1.query.html index 1b0674d3e4..2546246868 100644 --- a/docs/dyn/cloudsearch_v1.query.html +++ b/docs/dyn/cloudsearch_v1.query.html @@ -108,7 +108,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # The search API request. +{ # The search API request. NEXT ID: 17 "contextAttributes": [ # Context attributes for the request which will be used to adjust ranking of search results. The maximum number of elements is 10. { # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request. "name": "A String", # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched. @@ -199,7 +199,7 @@

Method Details

{ # Debug Search Response. "gsrRequest": "A String", # Serialized string of GenericSearchRequest. "gsrResponse": "A String", # Serialized string of GenericSearchResponse. - "searchResponse": { # The search API response. # Search response. + "searchResponse": { # The search API response. NEXT ID: 17 # Search response. "debugInfo": { # Debugging information about the response. # Debugging information about the response. "formattedDebugInfo": "A String", # General debug info formatted for display. }, @@ -545,7 +545,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # The search API request. +{ # The search API request. NEXT ID: 17 "contextAttributes": [ # Context attributes for the request which will be used to adjust ranking of search results. The maximum number of elements is 10. { # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request. "name": "A String", # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched. @@ -633,7 +633,7 @@

Method Details

Returns: An object of the form: - { # The search API response. + { # The search API response. NEXT ID: 17 "debugInfo": { # Debugging information about the response. # Debugging information about the response. "formattedDebugInfo": "A String", # General debug info formatted for display. }, diff --git a/docs/dyn/compute_alpha.backendBuckets.html b/docs/dyn/compute_alpha.backendBuckets.html index ca1649aeef..88a6a7a7e4 100644 --- a/docs/dyn/compute_alpha.backendBuckets.html +++ b/docs/dyn/compute_alpha.backendBuckets.html @@ -601,7 +601,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -615,7 +615,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -629,52 +628,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }
@@ -1403,7 +1356,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1419,7 +1371,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1433,7 +1385,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1447,52 +1398,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1507,7 +1412,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1521,7 +1426,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1535,52 +1439,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }
diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html index ca8c5a96a4..560e990a5b 100644 --- a/docs/dyn/compute_alpha.backendServices.html +++ b/docs/dyn/compute_alpha.backendServices.html @@ -1628,7 +1628,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1642,7 +1642,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1656,52 +1655,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -4114,7 +4067,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -4130,7 +4082,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -4144,7 +4096,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -4158,52 +4109,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -4218,7 +4123,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -4232,7 +4137,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -4246,52 +4150,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.crossSiteNetworks.html b/docs/dyn/compute_alpha.crossSiteNetworks.html new file mode 100644 index 0000000000..0d906d0350 --- /dev/null +++ b/docs/dyn/compute_alpha.crossSiteNetworks.html @@ -0,0 +1,598 @@ + + + +

Compute Engine API . crossSiteNetworks

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(project, crossSiteNetwork, requestId=None, x__xgafv=None)

+

Deletes the specified cross-site network in the given scope.

+

+ get(project, crossSiteNetwork, x__xgafv=None)

+

Returns the specified cross-site network in the given scope.

+

+ insert(project, body=None, requestId=None, validateOnly=None, x__xgafv=None)

+

Creates a cross-site network in the specified project in the given scope using the parameters that are included in the request.

+

+ list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists the cross-site networks for a project in the given scope.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(project, crossSiteNetwork, body=None, requestId=None, validateOnly=None, x__xgafv=None)

+

Updates the specified cross-site network with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(project, crossSiteNetwork, requestId=None, x__xgafv=None) +
Deletes the specified cross-site network in the given scope.
+
+Args:
+  project: string, Project ID for this request. (required)
+  crossSiteNetwork: string, Name of the cross-site network to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ get(project, crossSiteNetwork, x__xgafv=None) +
Returns the specified cross-site network in the given scope.
+
+Args:
+  project: string, Project ID for this request. (required)
+  crossSiteNetwork: string, Name of the cross-site network to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource that represents a cross-site network. You can use cross-site networks to connect your on-premises networks to each other through Interconnect connections.
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # An optional description of the cross-site network.
+  "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.
+  "kind": "compute#crossSiteNetwork", # [Output Only] Type of the resource. Always compute#crossSiteNetwork for cross-site networks.
+  "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.
+  "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.
+}
+
+ +
+ insert(project, body=None, requestId=None, validateOnly=None, x__xgafv=None) +
Creates a cross-site network in the specified project in the given scope using the parameters that are included in the request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A resource that represents a cross-site network. You can use cross-site networks to connect your on-premises networks to each other through Interconnect connections.
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # An optional description of the cross-site network.
+  "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.
+  "kind": "compute#crossSiteNetwork", # [Output Only] Type of the resource. Always compute#crossSiteNetwork for cross-site networks.
+  "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.
+  "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.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder
+  validateOnly: boolean, [Input Only] Validate the new configuration, but don't create it. If applicable, any configuration notices are returned in the `configurationNotices` field.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists the cross-site networks for a project in the given scope.
+
+Args:
+  project: string, Project ID for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response to the list request that contains a list of cross-site networks.
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of CrossSiteNetwork resources.
+    { # A resource that represents a cross-site network. You can use cross-site networks to connect your on-premises networks to each other through Interconnect connections.
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+      "description": "A String", # An optional description of the cross-site network.
+      "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.
+      "kind": "compute#crossSiteNetwork", # [Output Only] Type of the resource. Always compute#crossSiteNetwork for cross-site networks.
+      "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.
+      "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.
+    },
+  ],
+  "kind": "compute#crossSiteNetwork", # [Output Only] Type of the resource. Always compute#crossSiteNetwork for cross-site networks.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(project, crossSiteNetwork, body=None, requestId=None, validateOnly=None, x__xgafv=None) +
Updates the specified cross-site network with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
+
+Args:
+  project: string, Project ID for this request. (required)
+  crossSiteNetwork: string, Name of the cross-site network to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A resource that represents a cross-site network. You can use cross-site networks to connect your on-premises networks to each other through Interconnect connections.
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # An optional description of the cross-site network.
+  "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.
+  "kind": "compute#crossSiteNetwork", # [Output Only] Type of the resource. Always compute#crossSiteNetwork for cross-site networks.
+  "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.
+  "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.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder
+  validateOnly: boolean, [Input Only] Validate the new configuration, but don't update it. If applicable, any configuration notices are returned in the `configurationNotices` field.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_alpha.disks.html b/docs/dyn/compute_alpha.disks.html index c347974f9b..4ffebd1fc1 100644 --- a/docs/dyn/compute_alpha.disks.html +++ b/docs/dyn/compute_alpha.disks.html @@ -98,6 +98,9 @@

Instance Methods

get(project, zone, disk, x__xgafv=None)

Returns the specified persistent disk.

+

+ getAsyncReplicationStatus(project, zone, disk, x__xgafv=None)

+

Gets the status of current async replication for a given device.

getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

@@ -137,6 +140,9 @@

Instance Methods

update(project, zone, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)

Updates the specified disk with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.

+

+ waitForReplicationCatchUp(project, zone, disk, body=None, requestId=None, x__xgafv=None)

+

Wait for replication to catch up on the secondary disk.

Method Details

addResourcePolicies(project, zone, disk, body=None, requestId=None, x__xgafv=None) @@ -1081,6 +1087,40 @@

Method Details

}
+
+ getAsyncReplicationStatus(project, zone, disk, x__xgafv=None) +
Gets the status of current async replication for a given device.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  disk: string, Name of the Disk resource whose Async replication details are requested. Name should conform to RFC1035 or be an unsigned long integer. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "asyncReplicationStatus": {
+    "diskPairReplicationState": {
+      "dataReplicationState": "A String", # [Output Only] The status of disk creation. - ASYNC_REPLICATION_STATE_INITIALIZING: The device is doing the initial replication after starting the replication. - ASYNC_REPLICATION_STATE_REPLICATING_HEALTHY: The primary disk is healthily replicating to the secondary device i.e. last_replication_time is within RPO. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND: The replication is lagging above the SLO limit due to some internal issue. - ASYNC_REPLICATION_STATE_REPLICATING_UNHEALTHY: The replication is lagging, and the RPO is not being met due to some internal issue. . - ASYNC_REPLICATION_STATE_REPLICATION_STUCK: The replication is completely stuck due to some internal error. - ASYNC_REPLICATION_STATE_STOPPING: The replication is under the process of being stopped. This is a transient state. - ASYNC_REPLICATION_STATE_STOPPED: The replication between the disk-pairs have stopped.
+      "replicationDiskPair": {
+        "primaryDisk": "A String", # URL of the primary disk.
+        "secondaryDisk": "A String", # URL of the secondary disk.
+      },
+    },
+    "lastReplicationDetails": {
+      "lastReplicationTime": "A String", # The last sync time of the device pair.
+      "secondsSinceLastReplication": "A String", # Replication lag in seconds. This will only be populated if device is in replicating state. Note that the value is calculated sometime during request processing and at the instant the client receives the response, the current replication_lag may have changed.
+    },
+  },
+  "etag": "A String", # end_interface: MixerGetResponseWithEtagBuilder
+}
+
+
getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
@@ -1100,7 +1140,7 @@ 

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1114,7 +1154,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1128,52 +1167,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }
@@ -1890,7 +1883,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1906,7 +1898,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1920,7 +1912,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1934,52 +1925,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1994,7 +1939,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2008,7 +1953,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2022,52 +1966,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -2886,4 +2784,137 @@

Method Details

} +
+ waitForReplicationCatchUp(project, zone, disk, body=None, requestId=None, x__xgafv=None) +
Wait for replication to catch up on the secondary disk.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  disk: string, The name of the persistent disk. Name should conform to RFC1035 or be an unsigned long integer. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "maxWaitDuration": "A String",
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/compute_alpha.firewallPolicies.html b/docs/dyn/compute_alpha.firewallPolicies.html index 16a8d4cdcd..840d884d10 100644 --- a/docs/dyn/compute_alpha.firewallPolicies.html +++ b/docs/dyn/compute_alpha.firewallPolicies.html @@ -1186,7 +1186,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1200,7 +1200,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1214,52 +1213,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -3255,7 +3208,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -3271,7 +3223,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -3285,7 +3237,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -3299,52 +3250,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -3359,7 +3264,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -3373,7 +3278,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -3387,52 +3291,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.futureReservations.html b/docs/dyn/compute_alpha.futureReservations.html index c7a30f0a48..308432954a 100644 --- a/docs/dyn/compute_alpha.futureReservations.html +++ b/docs/dyn/compute_alpha.futureReservations.html @@ -155,7 +155,7 @@

Method Details

"namePrefix": "A String", # Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####. "planningStatus": "A String", # Planning state before being submitted for evaluation "reservationName": "A String", # Name of reservations where the capacity is provisioned at the time of delivery of future reservations. If the reservation with the given name does not exist already, it is created automatically at the time of Approval with INACTIVE state till specified start-time. Either provide the reservation_name or a name_prefix. - "schedulingType": "A String", # Indicates the maintenance type for this group of VMs. This will be set on the reservation via FR, and will be inherited for reservation blocks. + "schedulingType": "A String", # Maintenance information for this reservation "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. "shareSettings": { # The share setting for reservations and sole tenancy node groups. # List of Projects/Folders to share with. @@ -625,7 +625,7 @@

Method Details

"namePrefix": "A String", # Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####. "planningStatus": "A String", # Planning state before being submitted for evaluation "reservationName": "A String", # Name of reservations where the capacity is provisioned at the time of delivery of future reservations. If the reservation with the given name does not exist already, it is created automatically at the time of Approval with INACTIVE state till specified start-time. Either provide the reservation_name or a name_prefix. - "schedulingType": "A String", # Indicates the maintenance type for this group of VMs. This will be set on the reservation via FR, and will be inherited for reservation blocks. + "schedulingType": "A String", # Maintenance information for this reservation "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. "shareSettings": { # The share setting for reservations and sole tenancy node groups. # List of Projects/Folders to share with. @@ -788,7 +788,7 @@

Method Details

"namePrefix": "A String", # Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####. "planningStatus": "A String", # Planning state before being submitted for evaluation "reservationName": "A String", # Name of reservations where the capacity is provisioned at the time of delivery of future reservations. If the reservation with the given name does not exist already, it is created automatically at the time of Approval with INACTIVE state till specified start-time. Either provide the reservation_name or a name_prefix. - "schedulingType": "A String", # Indicates the maintenance type for this group of VMs. This will be set on the reservation via FR, and will be inherited for reservation blocks. + "schedulingType": "A String", # Maintenance information for this reservation "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. "shareSettings": { # The share setting for reservations and sole tenancy node groups. # List of Projects/Folders to share with. @@ -1082,7 +1082,7 @@

Method Details

"namePrefix": "A String", # Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####. "planningStatus": "A String", # Planning state before being submitted for evaluation "reservationName": "A String", # Name of reservations where the capacity is provisioned at the time of delivery of future reservations. If the reservation with the given name does not exist already, it is created automatically at the time of Approval with INACTIVE state till specified start-time. Either provide the reservation_name or a name_prefix. - "schedulingType": "A String", # Indicates the maintenance type for this group of VMs. This will be set on the reservation via FR, and will be inherited for reservation blocks. + "schedulingType": "A String", # Maintenance information for this reservation "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. "shareSettings": { # The share setting for reservations and sole tenancy node groups. # List of Projects/Folders to share with. @@ -1278,7 +1278,7 @@

Method Details

"namePrefix": "A String", # Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####. "planningStatus": "A String", # Planning state before being submitted for evaluation "reservationName": "A String", # Name of reservations where the capacity is provisioned at the time of delivery of future reservations. If the reservation with the given name does not exist already, it is created automatically at the time of Approval with INACTIVE state till specified start-time. Either provide the reservation_name or a name_prefix. - "schedulingType": "A String", # Indicates the maintenance type for this group of VMs. This will be set on the reservation via FR, and will be inherited for reservation blocks. + "schedulingType": "A String", # Maintenance information for this reservation "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. "shareSettings": { # The share setting for reservations and sole tenancy node groups. # List of Projects/Folders to share with. diff --git a/docs/dyn/compute_alpha.html b/docs/dyn/compute_alpha.html index 99f02c267b..be839dbce7 100644 --- a/docs/dyn/compute_alpha.html +++ b/docs/dyn/compute_alpha.html @@ -99,6 +99,11 @@

Instance Methods

Returns the backendServices Resource.

+

+ crossSiteNetworks() +

+

Returns the crossSiteNetworks Resource.

+

diskSettings()

@@ -634,6 +639,11 @@

Instance Methods

Returns the vpnTunnels Resource.

+

+ wireGroups() +

+

Returns the wireGroups Resource.

+

zoneOperations()

diff --git a/docs/dyn/compute_alpha.images.html b/docs/dyn/compute_alpha.images.html index 20299b0628..02b6a2786d 100644 --- a/docs/dyn/compute_alpha.images.html +++ b/docs/dyn/compute_alpha.images.html @@ -682,7 +682,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -696,7 +696,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -710,52 +709,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1451,7 +1404,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1467,7 +1419,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1481,7 +1433,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1495,52 +1446,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1555,7 +1460,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1569,7 +1474,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1583,52 +1487,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.instanceGroupManagers.html b/docs/dyn/compute_alpha.instanceGroupManagers.html index e90fbf7e74..5866446c8f 100644 --- a/docs/dyn/compute_alpha.instanceGroupManagers.html +++ b/docs/dyn/compute_alpha.instanceGroupManagers.html @@ -430,7 +430,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -1446,7 +1446,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -1701,7 +1701,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -2086,7 +2086,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -2698,7 +2698,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -4625,7 +4625,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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.instanceTemplates.html b/docs/dyn/compute_alpha.instanceTemplates.html index 8ead2cd9f1..5d18d2a3d8 100644 --- a/docs/dyn/compute_alpha.instanceTemplates.html +++ b/docs/dyn/compute_alpha.instanceTemplates.html @@ -430,6 +430,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -972,6 +976,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -1045,7 +1053,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1059,7 +1067,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1073,52 +1080,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1428,6 +1389,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -1923,6 +1888,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -2020,7 +1989,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2036,7 +2004,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2050,7 +2018,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2064,52 +2031,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -2124,7 +2045,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2138,7 +2059,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2152,52 +2072,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html index 3ff57268f6..90bc0b6ab3 100644 --- a/docs/dyn/compute_alpha.instances.html +++ b/docs/dyn/compute_alpha.instances.html @@ -1055,6 +1055,12 @@

Method Details

"terminationReason": "A String", # Reason for termination }, "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. + "physicalHostTopology": { # Represents the physical host topology of the host on which the VM is running. # [Output Only] The physical host topology of the host on which the VM is running. + "block": "A String", + "cluster": "A String", + "host": "A String", + "subblock": "A String", + }, "scheduling": { "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. @@ -1135,6 +1141,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -1798,6 +1808,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -2814,6 +2828,12 @@

Method Details

"terminationReason": "A String", # Reason for termination }, "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. + "physicalHostTopology": { # Represents the physical host topology of the host on which the VM is running. # [Output Only] The physical host topology of the host on which the VM is running. + "block": "A String", + "cluster": "A String", + "host": "A String", + "subblock": "A String", + }, "scheduling": { "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. @@ -2894,6 +2914,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -2986,12 +3010,12 @@

Method Details

An object of the form: { - "firewallPolicys": [ # Effective firewalls from firewall policies. + "firewallPolicys": [ # [Output Only] Effective firewalls from firewall policies. { "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy. "name": "A String", # [Output Only] The name of the firewall policy. "priority": 42, # [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. - "rules": [ # The rules that apply to the network. + "rules": [ # [Output Only] The rules that apply to the instance. Only rules that target the specific VM instance are returned if target service accounts or target secure tags are specified in the rules. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". "description": "A String", # An optional description for this resource. @@ -3360,7 +3384,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -3374,7 +3398,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -3388,52 +3411,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -3892,6 +3869,12 @@

Method Details

"terminationReason": "A String", # Reason for termination }, "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. + "physicalHostTopology": { # Represents the physical host topology of the host on which the VM is running. # [Output Only] The physical host topology of the host on which the VM is running. + "block": "A String", + "cluster": "A String", + "host": "A String", + "subblock": "A String", + }, "scheduling": { "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. @@ -3972,6 +3955,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -4493,6 +4480,12 @@

Method Details

"terminationReason": "A String", # Reason for termination }, "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. + "physicalHostTopology": { # Represents the physical host topology of the host on which the VM is running. # [Output Only] The physical host topology of the host on which the VM is running. + "block": "A String", + "cluster": "A String", + "host": "A String", + "subblock": "A String", + }, "scheduling": { "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. @@ -4573,6 +4566,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -5838,7 +5835,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -5854,7 +5850,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -5868,7 +5864,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -5882,52 +5877,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -5942,7 +5891,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -5956,7 +5905,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -5970,52 +5918,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -6887,6 +6789,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. } @@ -8685,6 +8591,12 @@

Method Details

"terminationReason": "A String", # Reason for termination }, "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. + "physicalHostTopology": { # Represents the physical host topology of the host on which the VM is running. # [Output Only] The physical host topology of the host on which the VM is running. + "block": "A String", + "cluster": "A String", + "host": "A String", + "subblock": "A String", + }, "scheduling": { "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. @@ -8765,6 +8677,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, diff --git a/docs/dyn/compute_alpha.instantSnapshotGroups.html b/docs/dyn/compute_alpha.instantSnapshotGroups.html index 1d1c4e83ec..ed5fc04c42 100644 --- a/docs/dyn/compute_alpha.instantSnapshotGroups.html +++ b/docs/dyn/compute_alpha.instantSnapshotGroups.html @@ -290,7 +290,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -304,7 +304,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -318,52 +317,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -610,7 +563,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -626,7 +578,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -640,7 +592,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -654,52 +605,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -714,7 +619,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -728,7 +633,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -742,52 +646,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.instantSnapshots.html b/docs/dyn/compute_alpha.instantSnapshots.html index da45ff389f..0f0a5f509c 100644 --- a/docs/dyn/compute_alpha.instantSnapshots.html +++ b/docs/dyn/compute_alpha.instantSnapshots.html @@ -407,7 +407,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -421,7 +421,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -435,52 +434,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -738,7 +691,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -754,7 +706,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -768,7 +720,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -782,52 +733,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -842,7 +747,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -856,7 +761,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -870,52 +774,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.interconnectAttachmentGroups.html b/docs/dyn/compute_alpha.interconnectAttachmentGroups.html index 51f6180fe2..a383d5e10d 100644 --- a/docs/dyn/compute_alpha.interconnectAttachmentGroups.html +++ b/docs/dyn/compute_alpha.interconnectAttachmentGroups.html @@ -334,7 +334,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -348,7 +348,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -362,52 +361,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -932,7 +885,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -948,7 +900,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -962,7 +914,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -976,52 +927,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1036,7 +941,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1050,7 +955,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1064,52 +968,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.interconnectAttachments.html b/docs/dyn/compute_alpha.interconnectAttachments.html index 367c4cc8e0..ec0c417949 100644 --- a/docs/dyn/compute_alpha.interconnectAttachments.html +++ b/docs/dyn/compute_alpha.interconnectAttachments.html @@ -488,7 +488,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -502,7 +502,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -516,52 +515,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1095,7 +1048,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1111,7 +1063,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1125,7 +1077,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1139,52 +1090,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1199,7 +1104,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1213,7 +1118,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1227,52 +1131,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.interconnectGroups.html b/docs/dyn/compute_alpha.interconnectGroups.html index a34c891c50..8756e1fbdc 100644 --- a/docs/dyn/compute_alpha.interconnectGroups.html +++ b/docs/dyn/compute_alpha.interconnectGroups.html @@ -331,7 +331,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -345,7 +345,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -359,52 +358,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -920,7 +873,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -936,7 +888,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -950,7 +902,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -964,52 +915,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1024,7 +929,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1038,7 +943,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1052,52 +956,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.interconnects.html b/docs/dyn/compute_alpha.interconnects.html index 7e588412cb..af18f8939f 100644 --- a/docs/dyn/compute_alpha.interconnects.html +++ b/docs/dyn/compute_alpha.interconnects.html @@ -260,9 +260,9 @@

Method Details

An object of the form: { # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview. - "aaiEnabled": True or False, # Enable or disable the Application Aware Interconnect(AAI) feature on this interconnect. + "aaiEnabled": True or False, # Enable or disable the application awareness feature on this Cloud Interconnect. "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. - "applicationAwareInterconnect": { # Configuration information for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router. # Configuration for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router. + "applicationAwareInterconnect": { # Configuration information for application awareness on this Cloud Interconnect. # Configuration information for application awareness on this Cloud Interconnect. "bandwidthPercentagePolicy": { "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. @@ -271,7 +271,7 @@

Method Details

}, ], }, - "profileDescription": "A String", # A description for the AAI profile on this interconnect. + "profileDescription": "A String", # Description for the application awareness profile on this Cloud Interconnect. "shapeAveragePercentages": [ # Optional field to specify a list of shape average percentages to be applied in conjunction with StrictPriorityPolicy or BandwidthPercentagePolicy. { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. "percentage": 42, # Bandwidth percentage for a specific traffic class. @@ -430,7 +430,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -444,7 +444,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -458,52 +457,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -548,9 +501,9 @@

Method Details

The object takes the form of: { # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview. - "aaiEnabled": True or False, # Enable or disable the Application Aware Interconnect(AAI) feature on this interconnect. + "aaiEnabled": True or False, # Enable or disable the application awareness feature on this Cloud Interconnect. "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. - "applicationAwareInterconnect": { # Configuration information for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router. # Configuration for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router. + "applicationAwareInterconnect": { # Configuration information for application awareness on this Cloud Interconnect. # Configuration information for application awareness on this Cloud Interconnect. "bandwidthPercentagePolicy": { "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. @@ -559,7 +512,7 @@

Method Details

}, ], }, - "profileDescription": "A String", # A description for the AAI profile on this interconnect. + "profileDescription": "A String", # Description for the application awareness profile on this Cloud Interconnect. "shapeAveragePercentages": [ # Optional field to specify a list of shape average percentages to be applied in conjunction with StrictPriorityPolicy or BandwidthPercentagePolicy. { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. "percentage": 42, # Bandwidth percentage for a specific traffic class. @@ -780,9 +733,9 @@

Method Details

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of Interconnect resources. { # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview. - "aaiEnabled": True or False, # Enable or disable the Application Aware Interconnect(AAI) feature on this interconnect. + "aaiEnabled": True or False, # Enable or disable the application awareness feature on this Cloud Interconnect. "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. - "applicationAwareInterconnect": { # Configuration information for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router. # Configuration for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router. + "applicationAwareInterconnect": { # Configuration information for application awareness on this Cloud Interconnect. # Configuration information for application awareness on this Cloud Interconnect. "bandwidthPercentagePolicy": { "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. @@ -791,7 +744,7 @@

Method Details

}, ], }, - "profileDescription": "A String", # A description for the AAI profile on this interconnect. + "profileDescription": "A String", # Description for the application awareness profile on this Cloud Interconnect. "shapeAveragePercentages": [ # Optional field to specify a list of shape average percentages to be applied in conjunction with StrictPriorityPolicy or BandwidthPercentagePolicy. { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. "percentage": 42, # Bandwidth percentage for a specific traffic class. @@ -912,9 +865,9 @@

Method Details

The object takes the form of: { # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview. - "aaiEnabled": True or False, # Enable or disable the Application Aware Interconnect(AAI) feature on this interconnect. + "aaiEnabled": True or False, # Enable or disable the application awareness feature on this Cloud Interconnect. "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. - "applicationAwareInterconnect": { # Configuration information for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router. # Configuration for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router. + "applicationAwareInterconnect": { # Configuration information for application awareness on this Cloud Interconnect. # Configuration information for application awareness on this Cloud Interconnect. "bandwidthPercentagePolicy": { "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. @@ -923,7 +876,7 @@

Method Details

}, ], }, - "profileDescription": "A String", # A description for the AAI profile on this interconnect. + "profileDescription": "A String", # Description for the application awareness profile on this Cloud Interconnect. "shapeAveragePercentages": [ # Optional field to specify a list of shape average percentages to be applied in conjunction with StrictPriorityPolicy or BandwidthPercentagePolicy. { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. "percentage": 42, # Bandwidth percentage for a specific traffic class. @@ -1134,7 +1087,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1150,7 +1102,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1164,7 +1116,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1178,52 +1129,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1238,7 +1143,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1252,7 +1157,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1266,52 +1170,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.licenseCodes.html b/docs/dyn/compute_alpha.licenseCodes.html index c91dacdc18..dad0a5ce83 100644 --- a/docs/dyn/compute_alpha.licenseCodes.html +++ b/docs/dyn/compute_alpha.licenseCodes.html @@ -165,7 +165,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -179,7 +179,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -193,52 +192,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -256,7 +209,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -272,7 +224,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -286,7 +238,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -300,52 +251,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -360,7 +265,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -374,7 +279,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -388,52 +292,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.licenses.html b/docs/dyn/compute_alpha.licenses.html index 3ac235d008..89d6634ab0 100644 --- a/docs/dyn/compute_alpha.licenses.html +++ b/docs/dyn/compute_alpha.licenses.html @@ -302,7 +302,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -316,7 +316,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -330,52 +329,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -643,7 +596,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -659,7 +611,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -673,7 +625,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -687,52 +638,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -747,7 +652,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -761,7 +666,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -775,52 +679,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.machineImages.html b/docs/dyn/compute_alpha.machineImages.html index 0cdc4ccae0..d0818cb7b9 100644 --- a/docs/dyn/compute_alpha.machineImages.html +++ b/docs/dyn/compute_alpha.machineImages.html @@ -542,6 +542,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -782,6 +786,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -826,7 +834,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -840,7 +848,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -854,52 +861,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1208,6 +1169,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -1448,6 +1413,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -1909,6 +1878,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -2149,6 +2122,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -2217,7 +2194,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2233,7 +2209,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2247,7 +2223,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2261,52 +2236,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -2321,7 +2250,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2335,7 +2264,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2349,52 +2277,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.networkAttachments.html b/docs/dyn/compute_alpha.networkAttachments.html index ea8be2bfe8..52d41db7b8 100644 --- a/docs/dyn/compute_alpha.networkAttachments.html +++ b/docs/dyn/compute_alpha.networkAttachments.html @@ -418,7 +418,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -432,7 +432,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -446,52 +445,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -928,7 +881,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -944,7 +896,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -958,7 +910,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -972,52 +923,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1032,7 +937,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1046,7 +951,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1060,52 +964,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.networkFirewallPolicies.html b/docs/dyn/compute_alpha.networkFirewallPolicies.html index 85133fd6c6..812f02552e 100644 --- a/docs/dyn/compute_alpha.networkFirewallPolicies.html +++ b/docs/dyn/compute_alpha.networkFirewallPolicies.html @@ -1196,7 +1196,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1210,7 +1210,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1224,52 +1223,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -3257,7 +3210,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -3273,7 +3225,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -3287,7 +3239,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -3301,52 +3252,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -3361,7 +3266,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -3375,7 +3280,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -3389,52 +3293,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.networkProfiles.html b/docs/dyn/compute_alpha.networkProfiles.html index 7d606e50eb..2622a3f77c 100644 --- a/docs/dyn/compute_alpha.networkProfiles.html +++ b/docs/dyn/compute_alpha.networkProfiles.html @@ -131,13 +131,13 @@

Method Details

"allowSubInterfaces": "A String", # Specifies whether sub interfaces are allowed. "allowVpcPeering": "A String", # Specifies whether VPC peering is allowed. "allowVpn": "A String", # Specifies whether VPN creation is allowed. - "allowedSubnetPurposes": [ # Specifies which subnetwork purposes are supported. + "interfaceTypes": [ # If set, limits the interface types that the network supports. If empty, all interface types are supported. "A String", ], - "allowedSubnetStackTypes": [ # Specifies which subnetwork stack types are supported. + "subnetPurposes": [ # Specifies which subnetwork purposes are supported. "A String", ], - "interfaceTypes": [ # If set, limits the interface types that the network supports. If empty, all interface types are supported. + "subnetStackTypes": [ # Specifies which subnetwork stack types are supported. "A String", ], "unicast": "A String", # Specifies which type of unicast is supported. @@ -198,13 +198,13 @@

Method Details

"allowSubInterfaces": "A String", # Specifies whether sub interfaces are allowed. "allowVpcPeering": "A String", # Specifies whether VPC peering is allowed. "allowVpn": "A String", # Specifies whether VPN creation is allowed. - "allowedSubnetPurposes": [ # Specifies which subnetwork purposes are supported. + "interfaceTypes": [ # If set, limits the interface types that the network supports. If empty, all interface types are supported. "A String", ], - "allowedSubnetStackTypes": [ # Specifies which subnetwork stack types are supported. + "subnetPurposes": [ # Specifies which subnetwork purposes are supported. "A String", ], - "interfaceTypes": [ # If set, limits the interface types that the network supports. If empty, all interface types are supported. + "subnetStackTypes": [ # Specifies which subnetwork stack types are supported. "A String", ], "unicast": "A String", # Specifies which type of unicast is supported. diff --git a/docs/dyn/compute_alpha.networks.html b/docs/dyn/compute_alpha.networks.html index b9a0e45b2a..17fed11193 100644 --- a/docs/dyn/compute_alpha.networks.html +++ b/docs/dyn/compute_alpha.networks.html @@ -491,12 +491,12 @@

Method Details

An object of the form: { - "firewallPolicys": [ # Effective firewalls from firewall policy. + "firewallPolicys": [ # [Output Only] Effective firewalls from firewall policy. It returns Global Network Firewall Policies and Hierarchical Firewall Policies. Use regionNetworkFirewallPolicies.getEffectiveFirewalls to get Regional Network Firewall Policies as well. { "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy. "name": "A String", # [Output Only] The name of the firewall policy. "priority": 42, # [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. - "rules": [ # The rules that apply to the network. + "rules": [ # [Output Only] The rules that apply to the network. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". "description": "A String", # An optional description for this resource. diff --git a/docs/dyn/compute_alpha.nodeGroups.html b/docs/dyn/compute_alpha.nodeGroups.html index 8059741bb3..34623f07cf 100644 --- a/docs/dyn/compute_alpha.nodeGroups.html +++ b/docs/dyn/compute_alpha.nodeGroups.html @@ -732,7 +732,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -746,7 +746,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -760,52 +759,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1531,7 +1484,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1547,7 +1499,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1561,7 +1513,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1575,52 +1526,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1635,7 +1540,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1649,7 +1554,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1663,52 +1567,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.nodeTemplates.html b/docs/dyn/compute_alpha.nodeTemplates.html index 7d092c13a3..5f61e417d1 100644 --- a/docs/dyn/compute_alpha.nodeTemplates.html +++ b/docs/dyn/compute_alpha.nodeTemplates.html @@ -424,7 +424,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -438,7 +438,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -452,52 +451,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -775,7 +728,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -791,7 +743,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -805,7 +757,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -819,52 +770,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -879,7 +784,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -893,7 +798,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -907,52 +811,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.organizationSecurityPolicies.html b/docs/dyn/compute_alpha.organizationSecurityPolicies.html index 86726e2c89..5162662409 100644 --- a/docs/dyn/compute_alpha.organizationSecurityPolicies.html +++ b/docs/dyn/compute_alpha.organizationSecurityPolicies.html @@ -107,6 +107,9 @@

Instance Methods

listAssociations(targetResource=None, x__xgafv=None)

Lists associations of a specified target, i.e., organization or folder.

+

+ listPreconfiguredExpressionSets(filter=None, maxResults=None, orderBy=None, pageToken=None, parentId=None, returnPartialSuccess=None, x__xgafv=None)

+

Gets the current list of preconfigured Web Application Firewall (WAF) expressions.

list_next()

Retrieves the next page of results.

@@ -2051,6 +2054,47 @@

Method Details

} +
+ listPreconfiguredExpressionSets(filter=None, maxResults=None, orderBy=None, pageToken=None, parentId=None, returnPartialSuccess=None, x__xgafv=None) +
Gets the current list of preconfigured Web Application Firewall (WAF) expressions.
+
+Args:
+  filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+  parentId: string, Parent ID for this request.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "preconfiguredExpressionSets": {
+    "wafRules": {
+      "expressionSets": [ # List of entities that are currently supported for WAF rules.
+        {
+          "aliases": [ # A list of alternate IDs. The format should be: - E.g. XSS-stable Generic suffix like "stable" is particularly useful if a policy likes to avail newer set of expressions without having to change the policy. A given alias name can't be used for more than one entity set.
+            "A String",
+          ],
+          "expressions": [ # List of available expressions.
+            {
+              "id": "A String", # Expression ID should uniquely identify the origin of the expression. E.g. owasp-crs-v020901-id973337 identifies Owasp core rule set version 2.9.1 rule id 973337. The ID could be used to determine the individual attack definition that has been detected. It could also be used to exclude it from the policy in case of false positive. required
+              "sensitivity": 42, # The sensitivity value associated with the WAF rule ID. This corresponds to the ModSecurity paranoia level, ranging from 1 to 4. 0 is reserved for opt-in only rules.
+            },
+          ],
+          "id": "A String", # Google specified expression set ID. The format should be: - E.g. XSS-20170329 required
+        },
+      ],
+    },
+  },
+}
+
+
list_next()
Retrieves the next page of results.
diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html
index f9dde9afe1..2333f1804c 100644
--- a/docs/dyn/compute_alpha.regionBackendServices.html
+++ b/docs/dyn/compute_alpha.regionBackendServices.html
@@ -811,7 +811,7 @@ 

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -825,7 +825,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -839,52 +838,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }
@@ -3170,7 +3123,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -3186,7 +3138,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -3200,7 +3152,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -3214,52 +3165,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -3274,7 +3179,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -3288,7 +3193,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -3302,52 +3206,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.regionCommitments.html b/docs/dyn/compute_alpha.regionCommitments.html index d7dc1a509a..40d273a188 100644 --- a/docs/dyn/compute_alpha.regionCommitments.html +++ b/docs/dyn/compute_alpha.regionCommitments.html @@ -192,7 +192,7 @@

Method Details

"deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. - "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -202,12 +202,12 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. - "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). - "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for the group of hosts on this reservation including running VMs and unused hosts. Applicable only to accelerator optimized VM families beyond A3 only. For both DENSE or STANDARD reservation, granular maintenance information can be retried at reservation block level. - "enableOpportunisticMaintenance": True or False, # Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the reservation, and will be inherited for reservation blocks. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. - "schedulingType": "A String", # Indicates the maintenance type for this group of VMs. This will be set on the reservation, and will be inherited for reservation blocks. + "schedulingType": "A String", # The type of maintenance for the reservation. "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use window_start_time instead. @@ -275,7 +275,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -690,7 +690,7 @@

Method Details

"deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. - "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -700,12 +700,12 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. - "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). - "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for the group of hosts on this reservation including running VMs and unused hosts. Applicable only to accelerator optimized VM families beyond A3 only. For both DENSE or STANDARD reservation, granular maintenance information can be retried at reservation block level. - "enableOpportunisticMaintenance": True or False, # Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the reservation, and will be inherited for reservation blocks. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. - "schedulingType": "A String", # Indicates the maintenance type for this group of VMs. This will be set on the reservation, and will be inherited for reservation blocks. + "schedulingType": "A String", # The type of maintenance for the reservation. "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use window_start_time instead. @@ -773,7 +773,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -881,7 +881,7 @@

Method Details

"deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. - "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -891,12 +891,12 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. - "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). - "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for the group of hosts on this reservation including running VMs and unused hosts. Applicable only to accelerator optimized VM families beyond A3 only. For both DENSE or STANDARD reservation, granular maintenance information can be retried at reservation block level. - "enableOpportunisticMaintenance": True or False, # Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the reservation, and will be inherited for reservation blocks. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. - "schedulingType": "A String", # Indicates the maintenance type for this group of VMs. This will be set on the reservation, and will be inherited for reservation blocks. + "schedulingType": "A String", # The type of maintenance for the reservation. "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use window_start_time instead. @@ -964,7 +964,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -1202,7 +1202,7 @@

Method Details

"deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. - "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -1212,12 +1212,12 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. - "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). - "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for the group of hosts on this reservation including running VMs and unused hosts. Applicable only to accelerator optimized VM families beyond A3 only. For both DENSE or STANDARD reservation, granular maintenance information can be retried at reservation block level. - "enableOpportunisticMaintenance": True or False, # Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the reservation, and will be inherited for reservation blocks. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. - "schedulingType": "A String", # Indicates the maintenance type for this group of VMs. This will be set on the reservation, and will be inherited for reservation blocks. + "schedulingType": "A String", # The type of maintenance for the reservation. "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use window_start_time instead. @@ -1285,7 +1285,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -1455,7 +1455,7 @@

Method Details

"deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. - "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -1465,12 +1465,12 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. - "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). - "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for the group of hosts on this reservation including running VMs and unused hosts. Applicable only to accelerator optimized VM families beyond A3 only. For both DENSE or STANDARD reservation, granular maintenance information can be retried at reservation block level. - "enableOpportunisticMaintenance": True or False, # Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the reservation, and will be inherited for reservation blocks. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. - "schedulingType": "A String", # Indicates the maintenance type for this group of VMs. This will be set on the reservation, and will be inherited for reservation blocks. + "schedulingType": "A String", # The type of maintenance for the reservation. "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use window_start_time instead. @@ -1538,7 +1538,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -1744,7 +1744,7 @@

Method Details

"deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. - "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -1754,12 +1754,12 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. - "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). - "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for the group of hosts on this reservation including running VMs and unused hosts. Applicable only to accelerator optimized VM families beyond A3 only. For both DENSE or STANDARD reservation, granular maintenance information can be retried at reservation block level. - "enableOpportunisticMaintenance": True or False, # Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the reservation, and will be inherited for reservation blocks. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. - "schedulingType": "A String", # Indicates the maintenance type for this group of VMs. This will be set on the reservation, and will be inherited for reservation blocks. + "schedulingType": "A String", # The type of maintenance for the reservation. "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use window_start_time instead. @@ -1827,7 +1827,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], diff --git a/docs/dyn/compute_alpha.regionDisks.html b/docs/dyn/compute_alpha.regionDisks.html index 45e90fc843..03c9ea5f57 100644 --- a/docs/dyn/compute_alpha.regionDisks.html +++ b/docs/dyn/compute_alpha.regionDisks.html @@ -92,6 +92,9 @@

Instance Methods

get(project, region, disk, x__xgafv=None)

Returns a specified regional persistent disk.

+

+ getAsyncReplicationStatus(project, region, disk, x__xgafv=None)

+

Gets the status of current async replication for a given device.

getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

@@ -131,6 +134,9 @@

Instance Methods

update(project, region, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)

Update the specified disk with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.

+

+ waitForReplicationCatchUp(project, region, disk, body=None, requestId=None, x__xgafv=None)

+

Wait for replication to catch up on the secondary disk.

Method Details

addResourcePolicies(project, region, disk, body=None, requestId=None, x__xgafv=None) @@ -880,6 +886,40 @@

Method Details

}
+
+ getAsyncReplicationStatus(project, region, disk, x__xgafv=None) +
Gets the status of current async replication for a given device.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the zone for this request. (required)
+  disk: string, Name of the Disk resource whose Async replication details are requested. Name should conform to RFC1035 or be an unsigned long integer. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "asyncReplicationStatus": {
+    "diskPairReplicationState": {
+      "dataReplicationState": "A String", # [Output Only] The status of disk creation. - ASYNC_REPLICATION_STATE_INITIALIZING: The device is doing the initial replication after starting the replication. - ASYNC_REPLICATION_STATE_REPLICATING_HEALTHY: The primary disk is healthily replicating to the secondary device i.e. last_replication_time is within RPO. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND: The replication is lagging above the SLO limit due to some internal issue. - ASYNC_REPLICATION_STATE_REPLICATING_UNHEALTHY: The replication is lagging, and the RPO is not being met due to some internal issue. . - ASYNC_REPLICATION_STATE_REPLICATION_STUCK: The replication is completely stuck due to some internal error. - ASYNC_REPLICATION_STATE_STOPPING: The replication is under the process of being stopped. This is a transient state. - ASYNC_REPLICATION_STATE_STOPPED: The replication between the disk-pairs have stopped.
+      "replicationDiskPair": {
+        "primaryDisk": "A String", # URL of the primary disk.
+        "secondaryDisk": "A String", # URL of the secondary disk.
+      },
+    },
+    "lastReplicationDetails": {
+      "lastReplicationTime": "A String", # The last sync time of the device pair.
+      "secondsSinceLastReplication": "A String", # Replication lag in seconds. This will only be populated if device is in replicating state. Note that the value is calculated sometime during request processing and at the instant the client receives the response, the current replication_lag may have changed.
+    },
+  },
+  "etag": "A String", # end_interface: MixerGetResponseWithEtagBuilder
+}
+
+
getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
@@ -899,7 +939,7 @@ 

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -913,7 +953,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -927,52 +966,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }
@@ -1689,7 +1682,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1705,7 +1697,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1719,7 +1711,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1733,52 +1724,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1793,7 +1738,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1807,7 +1752,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1821,52 +1765,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -2685,4 +2583,137 @@

Method Details

} +
+ waitForReplicationCatchUp(project, region, disk, body=None, requestId=None, x__xgafv=None) +
Wait for replication to catch up on the secondary disk.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  disk: string, The name of the persistent disk. Name should conform to RFC1035 or be an unsigned long integer. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "maxWaitDuration": "A String",
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html index f0502822ba..25dc6e760d 100644 --- a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html @@ -1122,7 +1122,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -1377,7 +1377,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -1762,7 +1762,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -2374,7 +2374,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -4301,7 +4301,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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.regionInstanceTemplates.html b/docs/dyn/compute_alpha.regionInstanceTemplates.html index b98095d226..fac2c6a728 100644 --- a/docs/dyn/compute_alpha.regionInstanceTemplates.html +++ b/docs/dyn/compute_alpha.regionInstanceTemplates.html @@ -541,6 +541,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -902,6 +906,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -1398,6 +1406,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, diff --git a/docs/dyn/compute_alpha.regionInstances.html b/docs/dyn/compute_alpha.regionInstances.html index 4105150bb8..a368ff1750 100644 --- a/docs/dyn/compute_alpha.regionInstances.html +++ b/docs/dyn/compute_alpha.regionInstances.html @@ -383,6 +383,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, diff --git a/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html b/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html index 9217b39f7e..ec8a3f18fa 100644 --- a/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html +++ b/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html @@ -290,7 +290,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -304,7 +304,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -318,52 +317,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -610,7 +563,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -626,7 +578,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -640,7 +592,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -654,52 +605,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -714,7 +619,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -728,7 +633,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -742,52 +646,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.regionInstantSnapshots.html b/docs/dyn/compute_alpha.regionInstantSnapshots.html index 25eef244d6..6339515fd7 100644 --- a/docs/dyn/compute_alpha.regionInstantSnapshots.html +++ b/docs/dyn/compute_alpha.regionInstantSnapshots.html @@ -301,7 +301,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -315,7 +315,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -329,52 +328,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -632,7 +585,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -648,7 +600,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -662,7 +614,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -676,52 +627,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -736,7 +641,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -750,7 +655,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -764,52 +668,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.regionMultiMigs.html b/docs/dyn/compute_alpha.regionMultiMigs.html index a8ff26e110..964a599684 100644 --- a/docs/dyn/compute_alpha.regionMultiMigs.html +++ b/docs/dyn/compute_alpha.regionMultiMigs.html @@ -82,7 +82,7 @@

Instance Methods

Deletes a multi-MIG in the specified project.

get(project, region, multiMig, x__xgafv=None)

-

Returns the specified multi-MIG resource.

+

Returns all the details of a specific multi-MIG.

insert(project, region, body=None, requestId=None, x__xgafv=None)

Creates a multi-MIG in the specified project.

@@ -226,7 +226,7 @@

Method Details

get(project, region, multiMig, x__xgafv=None) -
Returns the specified multi-MIG resource.
+  
Returns all the details of a specific multi-MIG.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -346,7 +346,7 @@ 

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -500,8 +500,8 @@

Method Details

}, }, "region": "A String", # [Output only] The URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. You cannot set the region as a field in the request body. - "resourcePolicies": { # Resource policies message for a multi-MIG. Represents low level machine cluster behavior in several dimensions, all of which depend on the machine family and fleet. # Resource policies for this multi-MIG. - "workloadPolicy": "A String", # The URL of the workload policy that is specified for this multi-MIG. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + "resourcePolicies": { # Resource policies message for a multi-MIG. Specifies the workload policy configuration of the multi-MIG. # Resource policies for this multi-MIG. + "workloadPolicy": "A String", # The URL of the workload policy for this multi-MIG. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy }, "schedulingPolicy": { # Policy for handling provisioning and other scheduling-related events. # Policy for handling provisioning and other scheduling-related events. "provisioning": "A String", # How provisioning of parts (instance group managers) should be scheduled (coordinated or not). @@ -632,7 +632,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -786,8 +786,8 @@

Method Details

}, }, "region": "A String", # [Output only] The URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. You cannot set the region as a field in the request body. - "resourcePolicies": { # Resource policies message for a multi-MIG. Represents low level machine cluster behavior in several dimensions, all of which depend on the machine family and fleet. # Resource policies for this multi-MIG. - "workloadPolicy": "A String", # The URL of the workload policy that is specified for this multi-MIG. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + "resourcePolicies": { # Resource policies message for a multi-MIG. Specifies the workload policy configuration of the multi-MIG. # Resource policies for this multi-MIG. + "workloadPolicy": "A String", # The URL of the workload policy for this multi-MIG. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy }, "schedulingPolicy": { # Policy for handling provisioning and other scheduling-related events. # Policy for handling provisioning and other scheduling-related events. "provisioning": "A String", # How provisioning of parts (instance group managers) should be scheduled (coordinated or not). @@ -801,7 +801,7 @@

Method Details

}, } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents you from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -942,7 +942,7 @@

Method Details

{ "etag": "A String", "id": "A String", # Unique identifier for the resource; defined by the server. - "items": [ # A list of multi-MIG resources. + "items": [ # A list of multi-MIGs in the specified project and region. { # Multi-MIG represents a group of managed instance groups. "creationTimestamp": "A String", # [Output only] The creation timestamp of this multi-MIG in RFC3339 text format. "description": "A String", # An optional description of this resource. @@ -1049,7 +1049,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -1203,8 +1203,8 @@

Method Details

}, }, "region": "A String", # [Output only] The URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. You cannot set the region as a field in the request body. - "resourcePolicies": { # Resource policies message for a multi-MIG. Represents low level machine cluster behavior in several dimensions, all of which depend on the machine family and fleet. # Resource policies for this multi-MIG. - "workloadPolicy": "A String", # The URL of the workload policy that is specified for this multi-MIG. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + "resourcePolicies": { # Resource policies message for a multi-MIG. Specifies the workload policy configuration of the multi-MIG. # Resource policies for this multi-MIG. + "workloadPolicy": "A String", # The URL of the workload policy for this multi-MIG. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy }, "schedulingPolicy": { # Policy for handling provisioning and other scheduling-related events. # Policy for handling provisioning and other scheduling-related events. "provisioning": "A String", # How provisioning of parts (instance group managers) should be scheduled (coordinated or not). diff --git a/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html b/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html index a00bbcd3f5..d8dd8f83d2 100644 --- a/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html +++ b/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html @@ -985,12 +985,12 @@

Method Details

An object of the form: { - "firewallPolicys": [ # Effective firewalls from firewall policy. + "firewallPolicys": [ # [Output only] Effective firewalls from firewall policy. It applies to Regional Network Firewall Policies in the specified region, Global Network Firewall Policies and Hierachial Firewall Policies which are associated with the network. { "displayName": "A String", # [Output Only] The display name of the firewall policy. "name": "A String", # [Output Only] The name of the firewall policy. "priority": 42, # [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. - "rules": [ # The rules that apply to the network. + "rules": [ # [Output only] The rules that apply to the network. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". "description": "A String", # An optional description for this resource. @@ -1147,7 +1147,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1161,7 +1161,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1175,52 +1174,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }
@@ -2791,7 +2744,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2807,7 +2759,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2821,7 +2773,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2835,52 +2786,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -2895,7 +2800,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2909,7 +2814,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2923,52 +2827,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.regionSnapshots.html b/docs/dyn/compute_alpha.regionSnapshots.html index 74fc24be88..0fcce34ece 100644 --- a/docs/dyn/compute_alpha.regionSnapshots.html +++ b/docs/dyn/compute_alpha.regionSnapshots.html @@ -351,7 +351,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -365,7 +365,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -379,52 +378,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -782,7 +735,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -798,7 +750,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -812,7 +764,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -826,52 +777,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -886,7 +791,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -900,7 +805,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -914,52 +818,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.reservationBlocks.html b/docs/dyn/compute_alpha.reservationBlocks.html index 315b5e94bb..f1d2411b3d 100644 --- a/docs/dyn/compute_alpha.reservationBlocks.html +++ b/docs/dyn/compute_alpha.reservationBlocks.html @@ -111,18 +111,22 @@

Method Details

{ "resource": { # Represents a reservation block resource. - "count": 42, # [Output Only] Specifies the number of resources that are allocated in this block. It indicates the maximum number of VMs that a user can run on this particular block. + "count": 42, # [Output Only] The number of resources that are allocated in this reservation block. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. - "inUseCount": 42, # [Output Only] Indicates how many instances are in use on this block. + "inUseCount": 42, # [Output Only] The number of instances that are currently in use on this reservation block. "kind": "compute#reservationBlock", # [Output Only] Type of the resource. Always compute#reservationBlock for reservation blocks. "locationPrefix": "A String", # [Output Only] Obfuscated location where this reservation block physically resides in format /CCCC/GGGG. This matches the tripod specified in the VM topology information. Example: /USEAB1/0101/ is the location prefix in /USEAB1/0101/031/003 "name": "A String", # [Output Only] The name of this reservation block generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])? - "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # [Output Only] Maintenance information for the group of hosts on this reservation including running VMs and unused hosts. Applicable only to accelerator optimized VM families beyond A3 only. For both DENSE or STANDARD reservation, granular maintenance information can be retried at reservation block level. - "enableOpportunisticMaintenance": True or False, # Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the reservation, and will be inherited for reservation blocks. + "physicalTopology": { # [Output Only] The physical topology of the reservation block. + "block": "A String", # The hash of the capacity block within the cluster. + "cluster": "A String", # The cluster name of the reservation block. + }, + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # [Output Only] Maintenance information for this reservation block. + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. - "schedulingType": "A String", # Indicates the maintenance type for this group of VMs. This will be set on the reservation, and will be inherited for reservation blocks. + "schedulingType": "A String", # The type of maintenance for the reservation. "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use window_start_time instead. @@ -171,18 +175,22 @@

Method Details

"id": "A String", # Unique identifier for the resource; defined by the server. "items": [ # A list of reservation block resources. { # Represents a reservation block resource. - "count": 42, # [Output Only] Specifies the number of resources that are allocated in this block. It indicates the maximum number of VMs that a user can run on this particular block. + "count": 42, # [Output Only] The number of resources that are allocated in this reservation block. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. - "inUseCount": 42, # [Output Only] Indicates how many instances are in use on this block. + "inUseCount": 42, # [Output Only] The number of instances that are currently in use on this reservation block. "kind": "compute#reservationBlock", # [Output Only] Type of the resource. Always compute#reservationBlock for reservation blocks. "locationPrefix": "A String", # [Output Only] Obfuscated location where this reservation block physically resides in format /CCCC/GGGG. This matches the tripod specified in the VM topology information. Example: /USEAB1/0101/ is the location prefix in /USEAB1/0101/031/003 "name": "A String", # [Output Only] The name of this reservation block generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])? - "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # [Output Only] Maintenance information for the group of hosts on this reservation including running VMs and unused hosts. Applicable only to accelerator optimized VM families beyond A3 only. For both DENSE or STANDARD reservation, granular maintenance information can be retried at reservation block level. - "enableOpportunisticMaintenance": True or False, # Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the reservation, and will be inherited for reservation blocks. + "physicalTopology": { # [Output Only] The physical topology of the reservation block. + "block": "A String", # The hash of the capacity block within the cluster. + "cluster": "A String", # The cluster name of the reservation block. + }, + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # [Output Only] Maintenance information for this reservation block. + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. - "schedulingType": "A String", # Indicates the maintenance type for this group of VMs. This will be set on the reservation, and will be inherited for reservation blocks. + "schedulingType": "A String", # The type of maintenance for the reservation. "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use window_start_time instead. diff --git a/docs/dyn/compute_alpha.reservations.html b/docs/dyn/compute_alpha.reservations.html index 380507fa71..95afa92ac7 100644 --- a/docs/dyn/compute_alpha.reservations.html +++ b/docs/dyn/compute_alpha.reservations.html @@ -171,7 +171,7 @@

Method Details

"deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. - "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -181,12 +181,12 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. - "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). - "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for the group of hosts on this reservation including running VMs and unused hosts. Applicable only to accelerator optimized VM families beyond A3 only. For both DENSE or STANDARD reservation, granular maintenance information can be retried at reservation block level. - "enableOpportunisticMaintenance": True or False, # Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the reservation, and will be inherited for reservation blocks. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. - "schedulingType": "A String", # Indicates the maintenance type for this group of VMs. This will be set on the reservation, and will be inherited for reservation blocks. + "schedulingType": "A String", # The type of maintenance for the reservation. "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use window_start_time instead. @@ -254,7 +254,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -481,7 +481,7 @@

Method Details

"deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. - "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -491,12 +491,12 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. - "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). - "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for the group of hosts on this reservation including running VMs and unused hosts. Applicable only to accelerator optimized VM families beyond A3 only. For both DENSE or STANDARD reservation, granular maintenance information can be retried at reservation block level. - "enableOpportunisticMaintenance": True or False, # Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the reservation, and will be inherited for reservation blocks. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. - "schedulingType": "A String", # Indicates the maintenance type for this group of VMs. This will be set on the reservation, and will be inherited for reservation blocks. + "schedulingType": "A String", # The type of maintenance for the reservation. "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use window_start_time instead. @@ -564,7 +564,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. } @@ -588,7 +588,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -602,7 +602,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -616,52 +615,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -707,7 +660,7 @@

Method Details

"deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. - "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -717,12 +670,12 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. - "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). - "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for the group of hosts on this reservation including running VMs and unused hosts. Applicable only to accelerator optimized VM families beyond A3 only. For both DENSE or STANDARD reservation, granular maintenance information can be retried at reservation block level. - "enableOpportunisticMaintenance": True or False, # Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the reservation, and will be inherited for reservation blocks. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. - "schedulingType": "A String", # Indicates the maintenance type for this group of VMs. This will be set on the reservation, and will be inherited for reservation blocks. + "schedulingType": "A String", # The type of maintenance for the reservation. "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use window_start_time instead. @@ -790,7 +743,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. } @@ -966,7 +919,7 @@

Method Details

"deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. - "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -976,12 +929,12 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. - "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). - "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for the group of hosts on this reservation including running VMs and unused hosts. Applicable only to accelerator optimized VM families beyond A3 only. For both DENSE or STANDARD reservation, granular maintenance information can be retried at reservation block level. - "enableOpportunisticMaintenance": True or False, # Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the reservation, and will be inherited for reservation blocks. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. - "schedulingType": "A String", # Indicates the maintenance type for this group of VMs. This will be set on the reservation, and will be inherited for reservation blocks. + "schedulingType": "A String", # The type of maintenance for the reservation. "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use window_start_time instead. @@ -1049,7 +1002,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -1230,7 +1183,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1246,7 +1198,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1260,7 +1212,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1274,52 +1225,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1334,7 +1239,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1348,7 +1253,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1362,52 +1266,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1486,7 +1344,7 @@

Method Details

"deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. - "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -1496,12 +1354,12 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. - "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). - "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for the group of hosts on this reservation including running VMs and unused hosts. Applicable only to accelerator optimized VM families beyond A3 only. For both DENSE or STANDARD reservation, granular maintenance information can be retried at reservation block level. - "enableOpportunisticMaintenance": True or False, # Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the reservation, and will be inherited for reservation blocks. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. - "schedulingType": "A String", # Indicates the maintenance type for this group of VMs. This will be set on the reservation, and will be inherited for reservation blocks. + "schedulingType": "A String", # The type of maintenance for the reservation. "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use window_start_time instead. @@ -1569,7 +1427,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. } diff --git a/docs/dyn/compute_alpha.resourcePolicies.html b/docs/dyn/compute_alpha.resourcePolicies.html index 9f667389ee..36eefc78a8 100644 --- a/docs/dyn/compute_alpha.resourcePolicies.html +++ b/docs/dyn/compute_alpha.resourcePolicies.html @@ -536,7 +536,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -550,7 +550,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -564,52 +563,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1220,7 +1173,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1236,7 +1188,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1250,7 +1202,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1264,52 +1215,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1324,7 +1229,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1338,7 +1243,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1352,52 +1256,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.serviceAttachments.html b/docs/dyn/compute_alpha.serviceAttachments.html index 8119236cc6..65e283fa2c 100644 --- a/docs/dyn/compute_alpha.serviceAttachments.html +++ b/docs/dyn/compute_alpha.serviceAttachments.html @@ -449,7 +449,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -463,7 +463,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -477,52 +476,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1001,7 +954,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1017,7 +969,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1031,7 +983,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1045,52 +996,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1105,7 +1010,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1119,7 +1024,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1133,52 +1037,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.snapshots.html b/docs/dyn/compute_alpha.snapshots.html index 94e0f854a4..1e9bb33a25 100644 --- a/docs/dyn/compute_alpha.snapshots.html +++ b/docs/dyn/compute_alpha.snapshots.html @@ -505,7 +505,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -519,7 +519,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -533,52 +532,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -933,7 +886,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -949,7 +901,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -963,7 +915,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -977,52 +928,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1037,7 +942,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1051,7 +956,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1065,52 +969,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.storagePools.html b/docs/dyn/compute_alpha.storagePools.html index 3155de78a9..becda3a114 100644 --- a/docs/dyn/compute_alpha.storagePools.html +++ b/docs/dyn/compute_alpha.storagePools.html @@ -485,7 +485,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -499,7 +499,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -513,52 +512,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -964,7 +917,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -980,7 +932,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -994,7 +946,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1008,52 +959,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1068,7 +973,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1082,7 +987,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1096,52 +1000,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.subnetworks.html b/docs/dyn/compute_alpha.subnetworks.html index a62f97a658..780bfc4076 100644 --- a/docs/dyn/compute_alpha.subnetworks.html +++ b/docs/dyn/compute_alpha.subnetworks.html @@ -604,7 +604,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -618,7 +618,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -632,52 +631,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1261,7 +1214,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1277,7 +1229,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1291,7 +1243,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1305,52 +1256,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1365,7 +1270,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1379,7 +1284,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1393,52 +1297,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_alpha.wireGroups.html b/docs/dyn/compute_alpha.wireGroups.html new file mode 100644 index 0000000000..57a0d7a054 --- /dev/null +++ b/docs/dyn/compute_alpha.wireGroups.html @@ -0,0 +1,832 @@ + + + +

Compute Engine API . wireGroups

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(project, crossSiteNetwork, wireGroup, requestId=None, x__xgafv=None)

+

Deletes the specified wire group in the given scope.

+

+ get(project, crossSiteNetwork, wireGroup, x__xgafv=None)

+

Gets the specified wire group resource in the given scope.

+

+ insert(project, crossSiteNetwork, body=None, requestId=None, validateOnly=None, x__xgafv=None)

+

Creates a wire group in the specified project in the given scope using the parameters that are included in the request.

+

+ list(project, crossSiteNetwork, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists the wire groups for a project in the given scope.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(project, crossSiteNetwork, wireGroup, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)

+

Updates the specified wire group resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(project, crossSiteNetwork, wireGroup, requestId=None, x__xgafv=None) +
Deletes the specified wire group in the given scope.
+
+Args:
+  project: string, Project ID for this request. (required)
+  crossSiteNetwork: string, A parameter (required)
+  wireGroup: string, Name of the wire group resource to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ get(project, crossSiteNetwork, wireGroup, x__xgafv=None) +
Gets the specified wire group resource in the given scope.
+
+Args:
+  project: string, Project ID for this request. (required)
+  crossSiteNetwork: string, A parameter (required)
+  wireGroup: string, Name of the wire group resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource that represents a group of redundant wires.
+  "adminEnabled": True or False, # Indicates whether the wires in the wire group are enabled. When false, the wires in the wire group are disabled. When true and when there is simultaneously no wire-specific override of `adminEnabled` to false, a given wire is enabled. Defaults to true.
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # An optional description of the wire group.
+  "endpoints": { # A map that contains the logical endpoints of the wire group. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Endpoint object.
+    "a_key": { # A logical endpoint for the wire group. An endpoint represents a metro that contains redundant Interconnect connections. A wire group is created between two endpoints.
+      "interconnects": { # A map that contains the redundant Interconnect connections. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Interconnect object.
+        "a_key": { # The redundant Interconnect connections for this endpoint.
+          "interconnect": "A String", # An Interconnect connection. You can specify the connection as a partial or full URL. If the connection is in a different project from the cross-site network, use a format that specifies the project. See the following examples of partial and full URLs: global/interconnects/NAME projects/PROJECT_ID/global/interconnects/NAME - https://compute.googleapis.com/compute/projects/PROJECT_ID /global/interconnects/NAME
+          "vlanTags": [ # To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. - Port mode pseudowires must configure a value of `-1` for both endpoints.
+            42,
+          ],
+        },
+      },
+    },
+  },
+  "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.
+  "kind": "compute#wireGroup", # [Output Only] Type of the resource. Always compute#wireGroups for wire groups.
+  "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.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String",
+  "serviceLevel": { # Service level details determined for the wire group configuration. # Service level details determined for the wire group configuration.
+    "availabilityClass": "A String", # [Output Only] The availability SLA that the wire group qualifies for. One of the following: `NO_AVAILABILITY_SLA`, `AVAILABILITY_99`, or `AVAILABILITY_999`.
+  },
+  "wireGroupProperties": { # The properties of a wire group. These properties determine how a group of redundant wires are created and managed. # Properties of the wire group.
+    "type": "A String", # The type of the wire group, one of the following: - WIRE: a single pseudowire over two Interconnect connections with no redundancy. - REDUNDANT: two pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Each pseudowire connects Interconnect connections in matching edge availability domains of the two metros. - BOX_AND_CROSS: four pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Two pseudowires connect Interconnect connections in matching edge availability domains of the two metros. Two additional pseudowires connect the non-matching edge availability domains of the two metros.
+  },
+  "wireInputs": { # A map that contains optional settings for individual wires. Specify key-value pairs for the map as follows: - Key: the label of an existing wire. To view a wire label and its format, see the wires[].label field. - Value: a WireInputs object.
+    "a_key": { # Optional settings for individual wires. Allows wire-level control that can be useful for migration purposes. If you use this field, you opt-out of the SLA for the wire group.
+      "adminEnabled": True or False, # Indicates whether the wire is enabled. When false, the wire is disabled. When true and when the wire group of the wire is also enabled, the wire is enabled. Defaults to true.
+      "wirePropertyOverrides": { # The properties of a wire. # The overridden properties for the wire. Any properties that are not overridden are omitted from the object. Review the following guidelines: - If you apply wire overrides to a wire and its wire group bandwidth configuration is set to `SHARED_WITH_WIRE_GROUP`, the `meteredBandwidth` and `unmeteredBandwidth` properties must not differ from the wire group. - Overrides generate a `configurationNotice`. Ensure that differences in wire configuration are temporary. An example use case for wire overrides is slowly rolling out configuration changes to individual wires in a wire group.
+        "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires.
+        "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed.
+        "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10.
+        "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires.
+        "networkServiceClass": "A String", # The network service class.
+      },
+    },
+  },
+  "wireProperties": { # The properties of a wire. # Properties for all wires in the wire group.
+    "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires.
+    "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed.
+    "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10.
+    "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires.
+    "networkServiceClass": "A String", # The network service class.
+  },
+  "wires": [ # The single/redundant wire(s) managed by the wire group.
+    { # A pseudowire that connects two Interconnect connections.
+      "adminEnabled": True or False, # [Output Only] Indicates whether the wire is enabled. When false, the wire is disabled. When true and when the wire group of the wire is also enabled, the wire is enabled. Defaults to true.
+      "endpoints": [ # Wire endpoints are specific Interconnect connections.
+        { # Wire endpoints are specific Interconnect connections.
+          "interconnect": "A String",
+          "vlanTag": 42,
+        },
+      ],
+      "label": "A String", # [Output Only] A label that identifies the wire. The format of this label combines the existing labels of the wire group endpoints and Interconnect connections used by this wire in alphabetical order as follows: `ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1`, where: - ENDPOINT_A and ENDPOINT_B: are the labels that you entered as map keys when you specified the wire group endpoint objects. - CONNECTION_A1 and CONNECTION_B1: are the labels that you entered as map keys when you specified the wire group Interconnect objects.
+      "wireProperties": { # The properties of a wire. # [Output Only] Properties of the wire.
+        "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires.
+        "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed.
+        "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10.
+        "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires.
+        "networkServiceClass": "A String", # The network service class.
+      },
+    },
+  ],
+}
+
+ +
+ insert(project, crossSiteNetwork, body=None, requestId=None, validateOnly=None, x__xgafv=None) +
Creates a wire group in the specified project in the given scope using the parameters that are included in the request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  crossSiteNetwork: string, A parameter (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A resource that represents a group of redundant wires.
+  "adminEnabled": True or False, # Indicates whether the wires in the wire group are enabled. When false, the wires in the wire group are disabled. When true and when there is simultaneously no wire-specific override of `adminEnabled` to false, a given wire is enabled. Defaults to true.
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # An optional description of the wire group.
+  "endpoints": { # A map that contains the logical endpoints of the wire group. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Endpoint object.
+    "a_key": { # A logical endpoint for the wire group. An endpoint represents a metro that contains redundant Interconnect connections. A wire group is created between two endpoints.
+      "interconnects": { # A map that contains the redundant Interconnect connections. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Interconnect object.
+        "a_key": { # The redundant Interconnect connections for this endpoint.
+          "interconnect": "A String", # An Interconnect connection. You can specify the connection as a partial or full URL. If the connection is in a different project from the cross-site network, use a format that specifies the project. See the following examples of partial and full URLs: global/interconnects/NAME projects/PROJECT_ID/global/interconnects/NAME - https://compute.googleapis.com/compute/projects/PROJECT_ID /global/interconnects/NAME
+          "vlanTags": [ # To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. - Port mode pseudowires must configure a value of `-1` for both endpoints.
+            42,
+          ],
+        },
+      },
+    },
+  },
+  "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.
+  "kind": "compute#wireGroup", # [Output Only] Type of the resource. Always compute#wireGroups for wire groups.
+  "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.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String",
+  "serviceLevel": { # Service level details determined for the wire group configuration. # Service level details determined for the wire group configuration.
+    "availabilityClass": "A String", # [Output Only] The availability SLA that the wire group qualifies for. One of the following: `NO_AVAILABILITY_SLA`, `AVAILABILITY_99`, or `AVAILABILITY_999`.
+  },
+  "wireGroupProperties": { # The properties of a wire group. These properties determine how a group of redundant wires are created and managed. # Properties of the wire group.
+    "type": "A String", # The type of the wire group, one of the following: - WIRE: a single pseudowire over two Interconnect connections with no redundancy. - REDUNDANT: two pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Each pseudowire connects Interconnect connections in matching edge availability domains of the two metros. - BOX_AND_CROSS: four pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Two pseudowires connect Interconnect connections in matching edge availability domains of the two metros. Two additional pseudowires connect the non-matching edge availability domains of the two metros.
+  },
+  "wireInputs": { # A map that contains optional settings for individual wires. Specify key-value pairs for the map as follows: - Key: the label of an existing wire. To view a wire label and its format, see the wires[].label field. - Value: a WireInputs object.
+    "a_key": { # Optional settings for individual wires. Allows wire-level control that can be useful for migration purposes. If you use this field, you opt-out of the SLA for the wire group.
+      "adminEnabled": True or False, # Indicates whether the wire is enabled. When false, the wire is disabled. When true and when the wire group of the wire is also enabled, the wire is enabled. Defaults to true.
+      "wirePropertyOverrides": { # The properties of a wire. # The overridden properties for the wire. Any properties that are not overridden are omitted from the object. Review the following guidelines: - If you apply wire overrides to a wire and its wire group bandwidth configuration is set to `SHARED_WITH_WIRE_GROUP`, the `meteredBandwidth` and `unmeteredBandwidth` properties must not differ from the wire group. - Overrides generate a `configurationNotice`. Ensure that differences in wire configuration are temporary. An example use case for wire overrides is slowly rolling out configuration changes to individual wires in a wire group.
+        "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires.
+        "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed.
+        "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10.
+        "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires.
+        "networkServiceClass": "A String", # The network service class.
+      },
+    },
+  },
+  "wireProperties": { # The properties of a wire. # Properties for all wires in the wire group.
+    "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires.
+    "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed.
+    "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10.
+    "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires.
+    "networkServiceClass": "A String", # The network service class.
+  },
+  "wires": [ # The single/redundant wire(s) managed by the wire group.
+    { # A pseudowire that connects two Interconnect connections.
+      "adminEnabled": True or False, # [Output Only] Indicates whether the wire is enabled. When false, the wire is disabled. When true and when the wire group of the wire is also enabled, the wire is enabled. Defaults to true.
+      "endpoints": [ # Wire endpoints are specific Interconnect connections.
+        { # Wire endpoints are specific Interconnect connections.
+          "interconnect": "A String",
+          "vlanTag": 42,
+        },
+      ],
+      "label": "A String", # [Output Only] A label that identifies the wire. The format of this label combines the existing labels of the wire group endpoints and Interconnect connections used by this wire in alphabetical order as follows: `ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1`, where: - ENDPOINT_A and ENDPOINT_B: are the labels that you entered as map keys when you specified the wire group endpoint objects. - CONNECTION_A1 and CONNECTION_B1: are the labels that you entered as map keys when you specified the wire group Interconnect objects.
+      "wireProperties": { # The properties of a wire. # [Output Only] Properties of the wire.
+        "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires.
+        "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed.
+        "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10.
+        "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires.
+        "networkServiceClass": "A String", # The network service class.
+      },
+    },
+  ],
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder
+  validateOnly: boolean, [Input Only] Validate the new configuration, but don't create it. If applicable, any configuration notices are returned in the `configurationNotices` field.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ list(project, crossSiteNetwork, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists the wire groups for a project in the given scope.
+
+Args:
+  project: string, Project ID for this request. (required)
+  crossSiteNetwork: string, A parameter (required)
+  filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the list request.
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of wire group resources.
+    { # A resource that represents a group of redundant wires.
+      "adminEnabled": True or False, # Indicates whether the wires in the wire group are enabled. When false, the wires in the wire group are disabled. When true and when there is simultaneously no wire-specific override of `adminEnabled` to false, a given wire is enabled. Defaults to true.
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+      "description": "A String", # An optional description of the wire group.
+      "endpoints": { # A map that contains the logical endpoints of the wire group. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Endpoint object.
+        "a_key": { # A logical endpoint for the wire group. An endpoint represents a metro that contains redundant Interconnect connections. A wire group is created between two endpoints.
+          "interconnects": { # A map that contains the redundant Interconnect connections. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Interconnect object.
+            "a_key": { # The redundant Interconnect connections for this endpoint.
+              "interconnect": "A String", # An Interconnect connection. You can specify the connection as a partial or full URL. If the connection is in a different project from the cross-site network, use a format that specifies the project. See the following examples of partial and full URLs: global/interconnects/NAME projects/PROJECT_ID/global/interconnects/NAME - https://compute.googleapis.com/compute/projects/PROJECT_ID /global/interconnects/NAME
+              "vlanTags": [ # To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. - Port mode pseudowires must configure a value of `-1` for both endpoints.
+                42,
+              ],
+            },
+          },
+        },
+      },
+      "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.
+      "kind": "compute#wireGroup", # [Output Only] Type of the resource. Always compute#wireGroups for wire groups.
+      "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.
+      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+      "selfLinkWithId": "A String",
+      "serviceLevel": { # Service level details determined for the wire group configuration. # Service level details determined for the wire group configuration.
+        "availabilityClass": "A String", # [Output Only] The availability SLA that the wire group qualifies for. One of the following: `NO_AVAILABILITY_SLA`, `AVAILABILITY_99`, or `AVAILABILITY_999`.
+      },
+      "wireGroupProperties": { # The properties of a wire group. These properties determine how a group of redundant wires are created and managed. # Properties of the wire group.
+        "type": "A String", # The type of the wire group, one of the following: - WIRE: a single pseudowire over two Interconnect connections with no redundancy. - REDUNDANT: two pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Each pseudowire connects Interconnect connections in matching edge availability domains of the two metros. - BOX_AND_CROSS: four pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Two pseudowires connect Interconnect connections in matching edge availability domains of the two metros. Two additional pseudowires connect the non-matching edge availability domains of the two metros.
+      },
+      "wireInputs": { # A map that contains optional settings for individual wires. Specify key-value pairs for the map as follows: - Key: the label of an existing wire. To view a wire label and its format, see the wires[].label field. - Value: a WireInputs object.
+        "a_key": { # Optional settings for individual wires. Allows wire-level control that can be useful for migration purposes. If you use this field, you opt-out of the SLA for the wire group.
+          "adminEnabled": True or False, # Indicates whether the wire is enabled. When false, the wire is disabled. When true and when the wire group of the wire is also enabled, the wire is enabled. Defaults to true.
+          "wirePropertyOverrides": { # The properties of a wire. # The overridden properties for the wire. Any properties that are not overridden are omitted from the object. Review the following guidelines: - If you apply wire overrides to a wire and its wire group bandwidth configuration is set to `SHARED_WITH_WIRE_GROUP`, the `meteredBandwidth` and `unmeteredBandwidth` properties must not differ from the wire group. - Overrides generate a `configurationNotice`. Ensure that differences in wire configuration are temporary. An example use case for wire overrides is slowly rolling out configuration changes to individual wires in a wire group.
+            "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires.
+            "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed.
+            "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10.
+            "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires.
+            "networkServiceClass": "A String", # The network service class.
+          },
+        },
+      },
+      "wireProperties": { # The properties of a wire. # Properties for all wires in the wire group.
+        "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires.
+        "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed.
+        "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10.
+        "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires.
+        "networkServiceClass": "A String", # The network service class.
+      },
+      "wires": [ # The single/redundant wire(s) managed by the wire group.
+        { # A pseudowire that connects two Interconnect connections.
+          "adminEnabled": True or False, # [Output Only] Indicates whether the wire is enabled. When false, the wire is disabled. When true and when the wire group of the wire is also enabled, the wire is enabled. Defaults to true.
+          "endpoints": [ # Wire endpoints are specific Interconnect connections.
+            { # Wire endpoints are specific Interconnect connections.
+              "interconnect": "A String",
+              "vlanTag": 42,
+            },
+          ],
+          "label": "A String", # [Output Only] A label that identifies the wire. The format of this label combines the existing labels of the wire group endpoints and Interconnect connections used by this wire in alphabetical order as follows: `ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1`, where: - ENDPOINT_A and ENDPOINT_B: are the labels that you entered as map keys when you specified the wire group endpoint objects. - CONNECTION_A1 and CONNECTION_B1: are the labels that you entered as map keys when you specified the wire group Interconnect objects.
+          "wireProperties": { # The properties of a wire. # [Output Only] Properties of the wire.
+            "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires.
+            "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed.
+            "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10.
+            "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires.
+            "networkServiceClass": "A String", # The network service class.
+          },
+        },
+      ],
+    },
+  ],
+  "kind": "compute#wireGroup", # [Output Only] Type of the resource. Always compute#wireGroups for wire groups.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(project, crossSiteNetwork, wireGroup, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None) +
Updates the specified wire group resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
+
+Args:
+  project: string, Project ID for this request. (required)
+  crossSiteNetwork: string, A parameter (required)
+  wireGroup: string, Name of the WireGroups resource to patch. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A resource that represents a group of redundant wires.
+  "adminEnabled": True or False, # Indicates whether the wires in the wire group are enabled. When false, the wires in the wire group are disabled. When true and when there is simultaneously no wire-specific override of `adminEnabled` to false, a given wire is enabled. Defaults to true.
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # An optional description of the wire group.
+  "endpoints": { # A map that contains the logical endpoints of the wire group. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Endpoint object.
+    "a_key": { # A logical endpoint for the wire group. An endpoint represents a metro that contains redundant Interconnect connections. A wire group is created between two endpoints.
+      "interconnects": { # A map that contains the redundant Interconnect connections. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Interconnect object.
+        "a_key": { # The redundant Interconnect connections for this endpoint.
+          "interconnect": "A String", # An Interconnect connection. You can specify the connection as a partial or full URL. If the connection is in a different project from the cross-site network, use a format that specifies the project. See the following examples of partial and full URLs: global/interconnects/NAME projects/PROJECT_ID/global/interconnects/NAME - https://compute.googleapis.com/compute/projects/PROJECT_ID /global/interconnects/NAME
+          "vlanTags": [ # To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. - Port mode pseudowires must configure a value of `-1` for both endpoints.
+            42,
+          ],
+        },
+      },
+    },
+  },
+  "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.
+  "kind": "compute#wireGroup", # [Output Only] Type of the resource. Always compute#wireGroups for wire groups.
+  "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.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String",
+  "serviceLevel": { # Service level details determined for the wire group configuration. # Service level details determined for the wire group configuration.
+    "availabilityClass": "A String", # [Output Only] The availability SLA that the wire group qualifies for. One of the following: `NO_AVAILABILITY_SLA`, `AVAILABILITY_99`, or `AVAILABILITY_999`.
+  },
+  "wireGroupProperties": { # The properties of a wire group. These properties determine how a group of redundant wires are created and managed. # Properties of the wire group.
+    "type": "A String", # The type of the wire group, one of the following: - WIRE: a single pseudowire over two Interconnect connections with no redundancy. - REDUNDANT: two pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Each pseudowire connects Interconnect connections in matching edge availability domains of the two metros. - BOX_AND_CROSS: four pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Two pseudowires connect Interconnect connections in matching edge availability domains of the two metros. Two additional pseudowires connect the non-matching edge availability domains of the two metros.
+  },
+  "wireInputs": { # A map that contains optional settings for individual wires. Specify key-value pairs for the map as follows: - Key: the label of an existing wire. To view a wire label and its format, see the wires[].label field. - Value: a WireInputs object.
+    "a_key": { # Optional settings for individual wires. Allows wire-level control that can be useful for migration purposes. If you use this field, you opt-out of the SLA for the wire group.
+      "adminEnabled": True or False, # Indicates whether the wire is enabled. When false, the wire is disabled. When true and when the wire group of the wire is also enabled, the wire is enabled. Defaults to true.
+      "wirePropertyOverrides": { # The properties of a wire. # The overridden properties for the wire. Any properties that are not overridden are omitted from the object. Review the following guidelines: - If you apply wire overrides to a wire and its wire group bandwidth configuration is set to `SHARED_WITH_WIRE_GROUP`, the `meteredBandwidth` and `unmeteredBandwidth` properties must not differ from the wire group. - Overrides generate a `configurationNotice`. Ensure that differences in wire configuration are temporary. An example use case for wire overrides is slowly rolling out configuration changes to individual wires in a wire group.
+        "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires.
+        "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed.
+        "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10.
+        "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires.
+        "networkServiceClass": "A String", # The network service class.
+      },
+    },
+  },
+  "wireProperties": { # The properties of a wire. # Properties for all wires in the wire group.
+    "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires.
+    "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed.
+    "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10.
+    "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires.
+    "networkServiceClass": "A String", # The network service class.
+  },
+  "wires": [ # The single/redundant wire(s) managed by the wire group.
+    { # A pseudowire that connects two Interconnect connections.
+      "adminEnabled": True or False, # [Output Only] Indicates whether the wire is enabled. When false, the wire is disabled. When true and when the wire group of the wire is also enabled, the wire is enabled. Defaults to true.
+      "endpoints": [ # Wire endpoints are specific Interconnect connections.
+        { # Wire endpoints are specific Interconnect connections.
+          "interconnect": "A String",
+          "vlanTag": 42,
+        },
+      ],
+      "label": "A String", # [Output Only] A label that identifies the wire. The format of this label combines the existing labels of the wire group endpoints and Interconnect connections used by this wire in alphabetical order as follows: `ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1`, where: - ENDPOINT_A and ENDPOINT_B: are the labels that you entered as map keys when you specified the wire group endpoint objects. - CONNECTION_A1 and CONNECTION_B1: are the labels that you entered as map keys when you specified the wire group Interconnect objects.
+      "wireProperties": { # The properties of a wire. # [Output Only] Properties of the wire.
+        "bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires.
+        "bandwidthMetered": "A String", # The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed.
+        "bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10.
+        "faultResponse": "A String", # Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires.
+        "networkServiceClass": "A String", # The network service class.
+      },
+    },
+  ],
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder
+  updateMask: string, update_mask indicates fields to be updated as part of this request.
+  validateOnly: boolean, [Input Only] Validate the new configuration, but don't update it. If applicable, any configuration notices are returned in the `configurationNotices` field.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_alpha.zoneQueuedResources.html b/docs/dyn/compute_alpha.zoneQueuedResources.html index 0ff1c3b860..47a36ba0d9 100644 --- a/docs/dyn/compute_alpha.zoneQueuedResources.html +++ b/docs/dyn/compute_alpha.zoneQueuedResources.html @@ -421,6 +421,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -1168,6 +1172,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -1608,6 +1616,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, @@ -2178,6 +2190,10 @@

Method Details

}, "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. "provisioningModel": "A String", # Specifies the provisioning model of the instance. + "shutdownTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. "windowsLicenseOptimizationMode": "A String", # Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. }, diff --git a/docs/dyn/compute_beta.backendBuckets.html b/docs/dyn/compute_beta.backendBuckets.html index c23da171cb..5541d9c903 100644 --- a/docs/dyn/compute_beta.backendBuckets.html +++ b/docs/dyn/compute_beta.backendBuckets.html @@ -591,7 +591,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -605,7 +605,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -619,52 +618,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1280,7 +1233,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1296,7 +1248,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1310,7 +1262,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1324,52 +1275,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1384,7 +1289,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1398,7 +1303,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1412,52 +1316,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.backendServices.html b/docs/dyn/compute_beta.backendServices.html index ee2815870a..461645f599 100644 --- a/docs/dyn/compute_beta.backendServices.html +++ b/docs/dyn/compute_beta.backendServices.html @@ -1131,7 +1131,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1145,7 +1145,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1159,52 +1158,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -2626,7 +2579,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2642,7 +2594,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2656,7 +2608,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2670,52 +2621,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -2730,7 +2635,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2744,7 +2649,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2758,52 +2662,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.disks.html b/docs/dyn/compute_beta.disks.html index 54810b3c05..d34cd8434c 100644 --- a/docs/dyn/compute_beta.disks.html +++ b/docs/dyn/compute_beta.disks.html @@ -1086,7 +1086,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1100,7 +1100,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1114,52 +1113,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1869,7 +1822,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1885,7 +1837,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1899,7 +1851,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1913,52 +1864,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1973,7 +1878,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1987,7 +1892,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2001,52 +1905,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.firewallPolicies.html b/docs/dyn/compute_beta.firewallPolicies.html index fce13df404..bd33323f73 100644 --- a/docs/dyn/compute_beta.firewallPolicies.html +++ b/docs/dyn/compute_beta.firewallPolicies.html @@ -1177,7 +1177,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1191,7 +1191,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1205,52 +1204,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -3231,7 +3184,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -3247,7 +3199,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -3261,7 +3213,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -3275,52 +3226,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -3335,7 +3240,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -3349,7 +3254,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -3363,52 +3267,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.futureReservations.html b/docs/dyn/compute_beta.futureReservations.html index 012600fbb6..5542766431 100644 --- a/docs/dyn/compute_beta.futureReservations.html +++ b/docs/dyn/compute_beta.futureReservations.html @@ -140,12 +140,17 @@

Method Details

}, "autoDeleteAutoCreatedReservations": True or False, # Setting for enabling or disabling automatic deletion for auto-created reservation. If set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this future reservation in RFC3339 text format. + "deploymentType": "A String", # Type of the deployment requested as part of future reservation. "description": "A String", # An optional description of this resource. Provide this property when you create the future reservation. + "enableOpportunisticMaintenance": True or False, # Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the FR by customers, and will be used for reservation and reservation block maintenance . "id": "A String", # [Output Only] A unique identifier for this future reservation. The server defines this identifier. + "instanceTerminationAction": "A String", # Action to take during reservation termination. "kind": "compute#futureReservation", # [Output Only] Type of the resource. Always compute#futureReservation for future reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "namePrefix": "A String", # Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####. "planningStatus": "A String", # Planning state before being submitted for evaluation + "reservationName": "A String", # Name of reservations where the capacity is provisioned at the time of delivery of future reservations. If the reservation with the given name does not exist already, it is created automatically at the time of Approval with INACTIVE state till specified start-time. Either provide the reservation_name or a name_prefix. + "schedulingType": "A String", # Maintenance information for this reservation "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. "shareSettings": { # The share setting for reservations and sole tenancy node groups. # List of Projects/Folders to share with. @@ -159,6 +164,7 @@

Method Details

], "shareType": "A String", # Type of sharing for this shared-reservation }, + "specificReservationRequired": True or False, # Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. "guestAccelerators": [ # Specifies accelerator type and count. @@ -587,12 +593,17 @@

Method Details

}, "autoDeleteAutoCreatedReservations": True or False, # Setting for enabling or disabling automatic deletion for auto-created reservation. If set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this future reservation in RFC3339 text format. + "deploymentType": "A String", # Type of the deployment requested as part of future reservation. "description": "A String", # An optional description of this resource. Provide this property when you create the future reservation. + "enableOpportunisticMaintenance": True or False, # Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the FR by customers, and will be used for reservation and reservation block maintenance . "id": "A String", # [Output Only] A unique identifier for this future reservation. The server defines this identifier. + "instanceTerminationAction": "A String", # Action to take during reservation termination. "kind": "compute#futureReservation", # [Output Only] Type of the resource. Always compute#futureReservation for future reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "namePrefix": "A String", # Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####. "planningStatus": "A String", # Planning state before being submitted for evaluation + "reservationName": "A String", # Name of reservations where the capacity is provisioned at the time of delivery of future reservations. If the reservation with the given name does not exist already, it is created automatically at the time of Approval with INACTIVE state till specified start-time. Either provide the reservation_name or a name_prefix. + "schedulingType": "A String", # Maintenance information for this reservation "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. "shareSettings": { # The share setting for reservations and sole tenancy node groups. # List of Projects/Folders to share with. @@ -606,6 +617,7 @@

Method Details

], "shareType": "A String", # Type of sharing for this shared-reservation }, + "specificReservationRequired": True or False, # Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. "guestAccelerators": [ # Specifies accelerator type and count. @@ -729,12 +741,17 @@

Method Details

}, "autoDeleteAutoCreatedReservations": True or False, # Setting for enabling or disabling automatic deletion for auto-created reservation. If set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this future reservation in RFC3339 text format. + "deploymentType": "A String", # Type of the deployment requested as part of future reservation. "description": "A String", # An optional description of this resource. Provide this property when you create the future reservation. + "enableOpportunisticMaintenance": True or False, # Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the FR by customers, and will be used for reservation and reservation block maintenance . "id": "A String", # [Output Only] A unique identifier for this future reservation. The server defines this identifier. + "instanceTerminationAction": "A String", # Action to take during reservation termination. "kind": "compute#futureReservation", # [Output Only] Type of the resource. Always compute#futureReservation for future reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "namePrefix": "A String", # Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####. "planningStatus": "A String", # Planning state before being submitted for evaluation + "reservationName": "A String", # Name of reservations where the capacity is provisioned at the time of delivery of future reservations. If the reservation with the given name does not exist already, it is created automatically at the time of Approval with INACTIVE state till specified start-time. Either provide the reservation_name or a name_prefix. + "schedulingType": "A String", # Maintenance information for this reservation "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. "shareSettings": { # The share setting for reservations and sole tenancy node groups. # List of Projects/Folders to share with. @@ -748,6 +765,7 @@

Method Details

], "shareType": "A String", # Type of sharing for this shared-reservation }, + "specificReservationRequired": True or False, # Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. "guestAccelerators": [ # Specifies accelerator type and count. @@ -1001,12 +1019,17 @@

Method Details

}, "autoDeleteAutoCreatedReservations": True or False, # Setting for enabling or disabling automatic deletion for auto-created reservation. If set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this future reservation in RFC3339 text format. + "deploymentType": "A String", # Type of the deployment requested as part of future reservation. "description": "A String", # An optional description of this resource. Provide this property when you create the future reservation. + "enableOpportunisticMaintenance": True or False, # Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the FR by customers, and will be used for reservation and reservation block maintenance . "id": "A String", # [Output Only] A unique identifier for this future reservation. The server defines this identifier. + "instanceTerminationAction": "A String", # Action to take during reservation termination. "kind": "compute#futureReservation", # [Output Only] Type of the resource. Always compute#futureReservation for future reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "namePrefix": "A String", # Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####. "planningStatus": "A String", # Planning state before being submitted for evaluation + "reservationName": "A String", # Name of reservations where the capacity is provisioned at the time of delivery of future reservations. If the reservation with the given name does not exist already, it is created automatically at the time of Approval with INACTIVE state till specified start-time. Either provide the reservation_name or a name_prefix. + "schedulingType": "A String", # Maintenance information for this reservation "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. "shareSettings": { # The share setting for reservations and sole tenancy node groups. # List of Projects/Folders to share with. @@ -1020,6 +1043,7 @@

Method Details

], "shareType": "A String", # Type of sharing for this shared-reservation }, + "specificReservationRequired": True or False, # Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. "guestAccelerators": [ # Specifies accelerator type and count. @@ -1176,12 +1200,17 @@

Method Details

}, "autoDeleteAutoCreatedReservations": True or False, # Setting for enabling or disabling automatic deletion for auto-created reservation. If set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this future reservation in RFC3339 text format. + "deploymentType": "A String", # Type of the deployment requested as part of future reservation. "description": "A String", # An optional description of this resource. Provide this property when you create the future reservation. + "enableOpportunisticMaintenance": True or False, # Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the FR by customers, and will be used for reservation and reservation block maintenance . "id": "A String", # [Output Only] A unique identifier for this future reservation. The server defines this identifier. + "instanceTerminationAction": "A String", # Action to take during reservation termination. "kind": "compute#futureReservation", # [Output Only] Type of the resource. Always compute#futureReservation for future reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "namePrefix": "A String", # Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####. "planningStatus": "A String", # Planning state before being submitted for evaluation + "reservationName": "A String", # Name of reservations where the capacity is provisioned at the time of delivery of future reservations. If the reservation with the given name does not exist already, it is created automatically at the time of Approval with INACTIVE state till specified start-time. Either provide the reservation_name or a name_prefix. + "schedulingType": "A String", # Maintenance information for this reservation "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. "shareSettings": { # The share setting for reservations and sole tenancy node groups. # List of Projects/Folders to share with. @@ -1195,6 +1224,7 @@

Method Details

], "shareType": "A String", # Type of sharing for this shared-reservation }, + "specificReservationRequired": True or False, # Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. "guestAccelerators": [ # Specifies accelerator type and count. diff --git a/docs/dyn/compute_beta.html b/docs/dyn/compute_beta.html index 0c94e18a70..901cc929e2 100644 --- a/docs/dyn/compute_beta.html +++ b/docs/dyn/compute_beta.html @@ -469,6 +469,11 @@

Instance Methods

Returns the regions Resource.

+

+ reservationBlocks() +

+

Returns the reservationBlocks Resource.

+

reservations()

diff --git a/docs/dyn/compute_beta.images.html b/docs/dyn/compute_beta.images.html index aa85df212b..1f129ba119 100644 --- a/docs/dyn/compute_beta.images.html +++ b/docs/dyn/compute_beta.images.html @@ -678,7 +678,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -692,7 +692,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -706,52 +705,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1442,7 +1395,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1458,7 +1410,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1472,7 +1424,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1486,52 +1437,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1546,7 +1451,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1560,7 +1465,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1574,52 +1478,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.instanceGroupManagers.html b/docs/dyn/compute_beta.instanceGroupManagers.html index 7457c33f23..f8f0a6ca6c 100644 --- a/docs/dyn/compute_beta.instanceGroupManagers.html +++ b/docs/dyn/compute_beta.instanceGroupManagers.html @@ -407,7 +407,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -1338,7 +1338,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -1517,7 +1517,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -1825,7 +1825,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -2349,7 +2349,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -4180,7 +4180,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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.instanceTemplates.html b/docs/dyn/compute_beta.instanceTemplates.html index 99d028c801..d0283a0923 100644 --- a/docs/dyn/compute_beta.instanceTemplates.html +++ b/docs/dyn/compute_beta.instanceTemplates.html @@ -956,7 +956,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -970,7 +970,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -984,52 +983,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1842,7 +1795,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1858,7 +1810,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1872,7 +1824,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1886,52 +1837,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1946,7 +1851,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1960,7 +1865,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1974,52 +1878,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.instances.html b/docs/dyn/compute_beta.instances.html index 16ea5a01d1..9893de04f3 100644 --- a/docs/dyn/compute_beta.instances.html +++ b/docs/dyn/compute_beta.instances.html @@ -2378,12 +2378,12 @@

Method Details

An object of the form: { - "firewallPolicys": [ # Effective firewalls from firewall policies. + "firewallPolicys": [ # [Output Only] Effective firewalls from firewall policies. { "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy. "name": "A String", # [Output Only] The name of the firewall policy. "priority": 42, # [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. - "rules": [ # The rules that apply to the network. + "rules": [ # [Output Only] The rules that apply to the instance. Only rules that target the specific VM instance are returned if target service accounts or target secure tags are specified in the rules. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". "description": "A String", # An optional description for this resource. @@ -2737,7 +2737,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2751,7 +2751,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2765,52 +2764,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -4842,7 +4795,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -4858,7 +4810,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -4872,7 +4824,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -4886,52 +4837,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -4946,7 +4851,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -4960,7 +4865,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -4974,52 +4878,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.instantSnapshots.html b/docs/dyn/compute_beta.instantSnapshots.html index 36d34ec2f2..3141ee80bc 100644 --- a/docs/dyn/compute_beta.instantSnapshots.html +++ b/docs/dyn/compute_beta.instantSnapshots.html @@ -400,7 +400,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -414,7 +414,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -428,52 +427,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -724,7 +677,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -740,7 +692,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -754,7 +706,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -768,52 +719,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -828,7 +733,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -842,7 +747,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -856,52 +760,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.interconnects.html b/docs/dyn/compute_beta.interconnects.html index 6e20657c3b..55e4bf2bc8 100644 --- a/docs/dyn/compute_beta.interconnects.html +++ b/docs/dyn/compute_beta.interconnects.html @@ -253,7 +253,27 @@

Method Details

An object of the form: { # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview. + "aaiEnabled": True or False, # Enable or disable the application awareness feature on this Cloud Interconnect. "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. + "applicationAwareInterconnect": { # Configuration information for application awareness on this Cloud Interconnect. # Configuration information for application awareness on this Cloud Interconnect. + "bandwidthPercentagePolicy": { + "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. + { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + }, + "profileDescription": "A String", # Description for the application awareness profile on this Cloud Interconnect. + "shapeAveragePercentages": [ # Optional field to specify a list of shape average percentages to be applied in conjunction with StrictPriorityPolicy or BandwidthPercentagePolicy. + { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. + }, + }, "availableFeatures": [ # [Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. "A String", ], @@ -421,7 +441,27 @@

Method Details

The object takes the form of: { # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview. + "aaiEnabled": True or False, # Enable or disable the application awareness feature on this Cloud Interconnect. "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. + "applicationAwareInterconnect": { # Configuration information for application awareness on this Cloud Interconnect. # Configuration information for application awareness on this Cloud Interconnect. + "bandwidthPercentagePolicy": { + "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. + { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + }, + "profileDescription": "A String", # Description for the application awareness profile on this Cloud Interconnect. + "shapeAveragePercentages": [ # Optional field to specify a list of shape average percentages to be applied in conjunction with StrictPriorityPolicy or BandwidthPercentagePolicy. + { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. + }, + }, "availableFeatures": [ # [Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. "A String", ], @@ -628,7 +668,27 @@

Method Details

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of Interconnect resources. { # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview. + "aaiEnabled": True or False, # Enable or disable the application awareness feature on this Cloud Interconnect. "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. + "applicationAwareInterconnect": { # Configuration information for application awareness on this Cloud Interconnect. # Configuration information for application awareness on this Cloud Interconnect. + "bandwidthPercentagePolicy": { + "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. + { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + }, + "profileDescription": "A String", # Description for the application awareness profile on this Cloud Interconnect. + "shapeAveragePercentages": [ # Optional field to specify a list of shape average percentages to be applied in conjunction with StrictPriorityPolicy or BandwidthPercentagePolicy. + { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. + }, + }, "availableFeatures": [ # [Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. "A String", ], @@ -736,7 +796,27 @@

Method Details

The object takes the form of: { # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview. + "aaiEnabled": True or False, # Enable or disable the application awareness feature on this Cloud Interconnect. "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. + "applicationAwareInterconnect": { # Configuration information for application awareness on this Cloud Interconnect. # Configuration information for application awareness on this Cloud Interconnect. + "bandwidthPercentagePolicy": { + "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. + { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + }, + "profileDescription": "A String", # Description for the application awareness profile on this Cloud Interconnect. + "shapeAveragePercentages": [ # Optional field to specify a list of shape average percentages to be applied in conjunction with StrictPriorityPolicy or BandwidthPercentagePolicy. + { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. + }, + }, "availableFeatures": [ # [Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. "A String", ], diff --git a/docs/dyn/compute_beta.licenses.html b/docs/dyn/compute_beta.licenses.html index 435b309d6c..487b140f54 100644 --- a/docs/dyn/compute_beta.licenses.html +++ b/docs/dyn/compute_beta.licenses.html @@ -281,7 +281,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -295,7 +295,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -309,52 +308,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -581,7 +534,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -597,7 +549,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -611,7 +563,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -625,52 +576,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -685,7 +590,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -699,7 +604,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -713,52 +617,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.machineImages.html b/docs/dyn/compute_beta.machineImages.html index ef0ce27b5d..eede8664e4 100644 --- a/docs/dyn/compute_beta.machineImages.html +++ b/docs/dyn/compute_beta.machineImages.html @@ -755,7 +755,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -769,7 +769,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -783,52 +782,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -2005,7 +1958,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2021,7 +1973,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2035,7 +1987,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2049,52 +2000,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -2109,7 +2014,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2123,7 +2028,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2137,52 +2041,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.networkAttachments.html b/docs/dyn/compute_beta.networkAttachments.html index c267f7717f..07f1a297ca 100644 --- a/docs/dyn/compute_beta.networkAttachments.html +++ b/docs/dyn/compute_beta.networkAttachments.html @@ -417,7 +417,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -431,7 +431,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -445,52 +444,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -925,7 +878,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -941,7 +893,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -955,7 +907,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -969,52 +920,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1029,7 +934,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1043,7 +948,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1057,52 +961,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.networkFirewallPolicies.html b/docs/dyn/compute_beta.networkFirewallPolicies.html index dadd2038e2..d8a688df32 100644 --- a/docs/dyn/compute_beta.networkFirewallPolicies.html +++ b/docs/dyn/compute_beta.networkFirewallPolicies.html @@ -1183,7 +1183,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1197,7 +1197,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1211,52 +1210,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -3094,7 +3047,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -3110,7 +3062,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -3124,7 +3076,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -3138,52 +3089,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -3198,7 +3103,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -3212,7 +3117,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -3226,52 +3130,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.networkProfiles.html b/docs/dyn/compute_beta.networkProfiles.html index 7f2a1227de..8d0df9e050 100644 --- a/docs/dyn/compute_beta.networkProfiles.html +++ b/docs/dyn/compute_beta.networkProfiles.html @@ -131,13 +131,13 @@

Method Details

"allowSubInterfaces": "A String", # Specifies whether sub interfaces are allowed. "allowVpcPeering": "A String", # Specifies whether VPC peering is allowed. "allowVpn": "A String", # Specifies whether VPN creation is allowed. - "allowedSubnetPurposes": [ # Specifies which subnetwork purposes are supported. + "interfaceTypes": [ # If set, limits the interface types that the network supports. If empty, all interface types are supported. "A String", ], - "allowedSubnetStackTypes": [ # Specifies which subnetwork stack types are supported. + "subnetPurposes": [ # Specifies which subnetwork purposes are supported. "A String", ], - "interfaceTypes": [ # If set, limits the interface types that the network supports. If empty, all interface types are supported. + "subnetStackTypes": [ # Specifies which subnetwork stack types are supported. "A String", ], "unicast": "A String", # Specifies which type of unicast is supported. @@ -198,13 +198,13 @@

Method Details

"allowSubInterfaces": "A String", # Specifies whether sub interfaces are allowed. "allowVpcPeering": "A String", # Specifies whether VPC peering is allowed. "allowVpn": "A String", # Specifies whether VPN creation is allowed. - "allowedSubnetPurposes": [ # Specifies which subnetwork purposes are supported. + "interfaceTypes": [ # If set, limits the interface types that the network supports. If empty, all interface types are supported. "A String", ], - "allowedSubnetStackTypes": [ # Specifies which subnetwork stack types are supported. + "subnetPurposes": [ # Specifies which subnetwork purposes are supported. "A String", ], - "interfaceTypes": [ # If set, limits the interface types that the network supports. If empty, all interface types are supported. + "subnetStackTypes": [ # Specifies which subnetwork stack types are supported. "A String", ], "unicast": "A String", # Specifies which type of unicast is supported. diff --git a/docs/dyn/compute_beta.networks.html b/docs/dyn/compute_beta.networks.html index 5c3131e554..f442b01010 100644 --- a/docs/dyn/compute_beta.networks.html +++ b/docs/dyn/compute_beta.networks.html @@ -472,12 +472,12 @@

Method Details

An object of the form: { - "firewallPolicys": [ # Effective firewalls from firewall policy. + "firewallPolicys": [ # [Output Only] Effective firewalls from firewall policy. It returns Global Network Firewall Policies and Hierarchical Firewall Policies. Use regionNetworkFirewallPolicies.getEffectiveFirewalls to get Regional Network Firewall Policies as well. { "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy. "name": "A String", # [Output Only] The name of the firewall policy. "priority": 42, # [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. - "rules": [ # The rules that apply to the network. + "rules": [ # [Output Only] The rules that apply to the network. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". "description": "A String", # An optional description for this resource. diff --git a/docs/dyn/compute_beta.nodeGroups.html b/docs/dyn/compute_beta.nodeGroups.html index 94fd6a3fd6..5b61f7c403 100644 --- a/docs/dyn/compute_beta.nodeGroups.html +++ b/docs/dyn/compute_beta.nodeGroups.html @@ -715,7 +715,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -729,7 +729,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -743,52 +742,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1484,7 +1437,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1500,7 +1452,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1514,7 +1466,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1528,52 +1479,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1588,7 +1493,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1602,7 +1507,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1616,52 +1520,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.nodeTemplates.html b/docs/dyn/compute_beta.nodeTemplates.html index cc1288d44b..c2cbeea54e 100644 --- a/docs/dyn/compute_beta.nodeTemplates.html +++ b/docs/dyn/compute_beta.nodeTemplates.html @@ -421,7 +421,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -435,7 +435,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -449,52 +448,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -769,7 +722,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -785,7 +737,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -799,7 +751,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -813,52 +764,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -873,7 +778,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -887,7 +792,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -901,52 +805,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.organizationSecurityPolicies.html b/docs/dyn/compute_beta.organizationSecurityPolicies.html index ed4d89a859..4df68aad15 100644 --- a/docs/dyn/compute_beta.organizationSecurityPolicies.html +++ b/docs/dyn/compute_beta.organizationSecurityPolicies.html @@ -107,6 +107,9 @@

Instance Methods

listAssociations(targetResource=None, x__xgafv=None)

Lists associations of a specified target, i.e., organization or folder.

+

+ listPreconfiguredExpressionSets(filter=None, maxResults=None, orderBy=None, pageToken=None, parentId=None, returnPartialSuccess=None, x__xgafv=None)

+

Gets the current list of preconfigured Web Application Firewall (WAF) expressions.

list_next()

Retrieves the next page of results.

@@ -1963,6 +1966,47 @@

Method Details

} +
+ listPreconfiguredExpressionSets(filter=None, maxResults=None, orderBy=None, pageToken=None, parentId=None, returnPartialSuccess=None, x__xgafv=None) +
Gets the current list of preconfigured Web Application Firewall (WAF) expressions.
+
+Args:
+  filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+  parentId: string, Parent ID for this request.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "preconfiguredExpressionSets": {
+    "wafRules": {
+      "expressionSets": [ # List of entities that are currently supported for WAF rules.
+        {
+          "aliases": [ # A list of alternate IDs. The format should be: - E.g. XSS-stable Generic suffix like "stable" is particularly useful if a policy likes to avail newer set of expressions without having to change the policy. A given alias name can't be used for more than one entity set.
+            "A String",
+          ],
+          "expressions": [ # List of available expressions.
+            {
+              "id": "A String", # Expression ID should uniquely identify the origin of the expression. E.g. owasp-crs-v020901-id973337 identifies Owasp core rule set version 2.9.1 rule id 973337. The ID could be used to determine the individual attack definition that has been detected. It could also be used to exclude it from the policy in case of false positive. required
+              "sensitivity": 42, # The sensitivity value associated with the WAF rule ID. This corresponds to the ModSecurity paranoia level, ranging from 1 to 4. 0 is reserved for opt-in only rules.
+            },
+          ],
+          "id": "A String", # Google specified expression set ID. The format should be: - E.g. XSS-20170329 required
+        },
+      ],
+    },
+  },
+}
+
+
list_next()
Retrieves the next page of results.
diff --git a/docs/dyn/compute_beta.regionBackendServices.html b/docs/dyn/compute_beta.regionBackendServices.html
index 4513e54b2d..2ddb6e1907 100644
--- a/docs/dyn/compute_beta.regionBackendServices.html
+++ b/docs/dyn/compute_beta.regionBackendServices.html
@@ -563,7 +563,7 @@ 

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -577,7 +577,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -591,52 +590,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }
@@ -1932,7 +1885,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1948,7 +1900,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1962,7 +1914,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1976,52 +1927,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -2036,7 +1941,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2050,7 +1955,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2064,52 +1968,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.regionCommitments.html b/docs/dyn/compute_beta.regionCommitments.html index c4088f6ec0..f6c5a3d8d6 100644 --- a/docs/dyn/compute_beta.regionCommitments.html +++ b/docs/dyn/compute_beta.regionCommitments.html @@ -183,8 +183,10 @@

Method Details

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -194,6 +196,21 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. + "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. + "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. + "schedulingType": "A String", # The type of maintenance for the reservation. + "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. + "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. + "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. + "maintenanceStatus": "A String", + "type": "A String", # Defines the type of maintenance. + "windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format. + "windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format. + }, + }, "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. @@ -240,7 +257,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -380,8 +397,10 @@

Method Details

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -391,6 +410,21 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. + "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. + "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. + "schedulingType": "A String", # The type of maintenance for the reservation. + "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. + "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. + "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. + "maintenanceStatus": "A String", + "type": "A String", # Defines the type of maintenance. + "windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format. + "windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format. + }, + }, "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. @@ -437,7 +471,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -522,8 +556,10 @@

Method Details

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -533,6 +569,21 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. + "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. + "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. + "schedulingType": "A String", # The type of maintenance for the reservation. + "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. + "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. + "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. + "maintenanceStatus": "A String", + "type": "A String", # Defines the type of maintenance. + "windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format. + "windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format. + }, + }, "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. @@ -579,7 +630,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -793,8 +844,10 @@

Method Details

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -804,6 +857,21 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. + "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. + "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. + "schedulingType": "A String", # The type of maintenance for the reservation. + "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. + "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. + "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. + "maintenanceStatus": "A String", + "type": "A String", # Defines the type of maintenance. + "windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format. + "windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format. + }, + }, "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. @@ -850,7 +918,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -997,8 +1065,10 @@

Method Details

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -1008,6 +1078,21 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. + "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. + "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. + "schedulingType": "A String", # The type of maintenance for the reservation. + "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. + "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. + "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. + "maintenanceStatus": "A String", + "type": "A String", # Defines the type of maintenance. + "windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format. + "windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format. + }, + }, "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. @@ -1054,7 +1139,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -1236,8 +1321,10 @@

Method Details

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -1247,6 +1334,21 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. + "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. + "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. + "schedulingType": "A String", # The type of maintenance for the reservation. + "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. + "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. + "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. + "maintenanceStatus": "A String", + "type": "A String", # Defines the type of maintenance. + "windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format. + "windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format. + }, + }, "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. @@ -1293,7 +1395,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], diff --git a/docs/dyn/compute_beta.regionDisks.html b/docs/dyn/compute_beta.regionDisks.html index bcc7b5685d..20c301539d 100644 --- a/docs/dyn/compute_beta.regionDisks.html +++ b/docs/dyn/compute_beta.regionDisks.html @@ -886,7 +886,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -900,7 +900,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -914,52 +913,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1669,7 +1622,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1685,7 +1637,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1699,7 +1651,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1713,52 +1664,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1773,7 +1678,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1787,7 +1692,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1801,52 +1705,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.regionInstanceGroupManagers.html b/docs/dyn/compute_beta.regionInstanceGroupManagers.html index e4ebeb2f24..3bd8bc6ff4 100644 --- a/docs/dyn/compute_beta.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_beta.regionInstanceGroupManagers.html @@ -1093,7 +1093,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -1272,7 +1272,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -1580,7 +1580,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -2104,7 +2104,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -3935,7 +3935,7 @@

Method Details

"listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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.regionInstantSnapshots.html b/docs/dyn/compute_beta.regionInstantSnapshots.html index ad58fffff0..eb7acf8fb0 100644 --- a/docs/dyn/compute_beta.regionInstantSnapshots.html +++ b/docs/dyn/compute_beta.regionInstantSnapshots.html @@ -297,7 +297,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -311,7 +311,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -325,52 +324,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -621,7 +574,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -637,7 +589,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -651,7 +603,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -665,52 +616,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -725,7 +630,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -739,7 +644,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -753,52 +657,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.regionMultiMigs.html b/docs/dyn/compute_beta.regionMultiMigs.html index 1a094b24fa..8728cac732 100644 --- a/docs/dyn/compute_beta.regionMultiMigs.html +++ b/docs/dyn/compute_beta.regionMultiMigs.html @@ -82,7 +82,7 @@

Instance Methods

Deletes a multi-MIG in the specified project.

get(project, region, multiMig, x__xgafv=None)

-

Returns the specified multi-MIG resource.

+

Returns all the details of a specific multi-MIG.

insert(project, region, body=None, requestId=None, x__xgafv=None)

Creates a multi-MIG in the specified project.

@@ -225,7 +225,7 @@

Method Details

get(project, region, multiMig, x__xgafv=None) -
Returns the specified multi-MIG resource.
+  
Returns all the details of a specific multi-MIG.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -276,7 +276,7 @@ 

Method Details

"selfLink": "A String", # [Output only] Server-defined URL for the resource. } - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents you from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -416,7 +416,7 @@

Method Details

{ "etag": "A String", "id": "A String", # Unique identifier for the resource; defined by the server. - "items": [ # A list of multi-MIG resources. + "items": [ # A list of multi-MIGs in the specified project and region. { # Multi-MIG represents a group of managed instance groups. "creationTimestamp": "A String", # [Output only] The creation timestamp of this multi-MIG in RFC3339 text format. "description": "A String", # An optional description of this resource. diff --git a/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html b/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html index b4daed2083..04531bb693 100644 --- a/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html +++ b/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html @@ -973,12 +973,12 @@

Method Details

An object of the form: { - "firewallPolicys": [ # Effective firewalls from firewall policy. + "firewallPolicys": [ # [Output only] Effective firewalls from firewall policy. It applies to Regional Network Firewall Policies in the specified region, Global Network Firewall Policies and Hierachial Firewall Policies which are associated with the network. { "displayName": "A String", # [Output Only] The display name of the firewall policy. "name": "A String", # [Output Only] The name of the firewall policy. "priority": 42, # [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. - "rules": [ # The rules that apply to the network. + "rules": [ # [Output only] The rules that apply to the network. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". "description": "A String", # An optional description for this resource. @@ -1134,7 +1134,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1148,7 +1148,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1162,52 +1161,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }
@@ -2629,7 +2582,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2645,7 +2597,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2659,7 +2611,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2673,52 +2624,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -2733,7 +2638,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2747,7 +2652,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2761,52 +2665,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.reservationBlocks.html b/docs/dyn/compute_beta.reservationBlocks.html new file mode 100644 index 0000000000..33c280d918 --- /dev/null +++ b/docs/dyn/compute_beta.reservationBlocks.html @@ -0,0 +1,231 @@ + + + +

Compute Engine API . reservationBlocks

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(project, zone, reservation, reservationBlock, x__xgafv=None)

+

Retrieves information about the specified reservation block.

+

+ list(project, zone, reservation, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Retrieves a list of reservation blocks under a single reservation.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(project, zone, reservation, reservationBlock, x__xgafv=None) +
Retrieves information about the specified reservation block.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
+  reservation: string, The name of the reservation. Name should conform to RFC1035 or be a resource ID. (required)
+  reservationBlock: string, The name of the reservation block. Name should conform to RFC1035 or be a resource ID. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "resource": { # Represents a reservation block resource.
+    "count": 42, # [Output Only] The number of resources that are allocated in this reservation block.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "inUseCount": 42, # [Output Only] The number of instances that are currently in use on this reservation block.
+    "kind": "compute#reservationBlock", # [Output Only] Type of the resource. Always compute#reservationBlock for reservation blocks.
+    "name": "A String", # [Output Only] The name of this reservation block generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
+    "physicalTopology": { # [Output Only] The physical topology of the reservation block.
+      "block": "A String", # The hash of the capacity block within the cluster.
+      "cluster": "A String", # The cluster name of the reservation block.
+    },
+    "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # [Output Only] Maintenance information for this reservation block.
+      "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible.
+      "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.
+      "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance.
+      "schedulingType": "A String", # The type of maintenance for the reservation.
+      "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
+        "canReschedule": True or False, # Indicates if the maintenance can be customer triggered.
+        "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
+        "maintenanceStatus": "A String",
+        "type": "A String", # Defines the type of maintenance.
+        "windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
+        "windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
+      },
+    },
+    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+    "status": "A String", # [Output Only] Status of the reservation block.
+    "zone": "A String", # [Output Only] Zone in which the reservation block resides.
+  },
+}
+
+ +
+ list(project, zone, reservation, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Retrieves a list of reservation blocks under a single reservation.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
+  reservation: string, The name of the reservation. Name should conform to RFC1035 or be a resource ID. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A list of reservation blocks under a single reservation.
+  "id": "A String", # Unique identifier for the resource; defined by the server.
+  "items": [ # A list of reservation block resources.
+    { # Represents a reservation block resource.
+      "count": 42, # [Output Only] The number of resources that are allocated in this reservation block.
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+      "inUseCount": 42, # [Output Only] The number of instances that are currently in use on this reservation block.
+      "kind": "compute#reservationBlock", # [Output Only] Type of the resource. Always compute#reservationBlock for reservation blocks.
+      "name": "A String", # [Output Only] The name of this reservation block generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
+      "physicalTopology": { # [Output Only] The physical topology of the reservation block.
+        "block": "A String", # The hash of the capacity block within the cluster.
+        "cluster": "A String", # The cluster name of the reservation block.
+      },
+      "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # [Output Only] Maintenance information for this reservation block.
+        "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible.
+        "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.
+        "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance.
+        "schedulingType": "A String", # The type of maintenance for the reservation.
+        "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
+          "canReschedule": True or False, # Indicates if the maintenance can be customer triggered.
+          "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
+          "maintenanceStatus": "A String",
+          "type": "A String", # Defines the type of maintenance.
+          "windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
+          "windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
+        },
+      },
+      "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+      "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+      "status": "A String", # [Output Only] Status of the reservation block.
+      "zone": "A String", # [Output Only] Zone in which the reservation block resides.
+    },
+  ],
+  "kind": "compute#reservationBlock", # Type of the resource. Always compute#reservationBlock for a list of reservation blocks.
+  "nextPageToken": "A String", # This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+  "selfLink": "A String", # Server-defined URL for this resource.
+  "warning": { # Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_beta.reservations.html b/docs/dyn/compute_beta.reservations.html index 788a9c3190..f9614d4288 100644 --- a/docs/dyn/compute_beta.reservations.html +++ b/docs/dyn/compute_beta.reservations.html @@ -168,8 +168,10 @@

Method Details

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -179,6 +181,21 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. + "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. + "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. + "schedulingType": "A String", # The type of maintenance for the reservation. + "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. + "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. + "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. + "maintenanceStatus": "A String", + "type": "A String", # Defines the type of maintenance. + "windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format. + "windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format. + }, + }, "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. @@ -225,7 +242,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -448,8 +465,10 @@

Method Details

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -459,6 +478,21 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. + "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. + "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. + "schedulingType": "A String", # The type of maintenance for the reservation. + "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. + "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. + "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. + "maintenanceStatus": "A String", + "type": "A String", # Defines the type of maintenance. + "windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format. + "windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format. + }, + }, "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. @@ -505,7 +539,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. } @@ -529,7 +563,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -543,7 +577,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -557,52 +590,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -645,8 +632,10 @@

Method Details

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -656,6 +645,21 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. + "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. + "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. + "schedulingType": "A String", # The type of maintenance for the reservation. + "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. + "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. + "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. + "maintenanceStatus": "A String", + "type": "A String", # Defines the type of maintenance. + "windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format. + "windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format. + }, + }, "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. @@ -702,7 +706,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. } @@ -874,8 +878,10 @@

Method Details

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -885,6 +891,21 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. + "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. + "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. + "schedulingType": "A String", # The type of maintenance for the reservation. + "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. + "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. + "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. + "maintenanceStatus": "A String", + "type": "A String", # Defines the type of maintenance. + "windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format. + "windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format. + }, + }, "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. @@ -931,7 +952,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -1111,7 +1132,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1127,7 +1147,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1141,7 +1161,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1155,52 +1174,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1215,7 +1188,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1229,7 +1202,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1243,52 +1215,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1364,8 +1290,10 @@

Method Details

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "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. + "instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -1375,6 +1303,21 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # The number of reservation blocks associated with this reservation. + "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation + "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. + "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. + "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. + "schedulingType": "A String", # The type of maintenance for the reservation. + "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs. + "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. + "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. + "maintenanceStatus": "A String", + "type": "A String", # Defines the type of maintenance. + "windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format. + "windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format. + }, + }, "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. @@ -1421,7 +1364,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. } diff --git a/docs/dyn/compute_beta.resourcePolicies.html b/docs/dyn/compute_beta.resourcePolicies.html index 0e3da1e5fa..0d0c815807 100644 --- a/docs/dyn/compute_beta.resourcePolicies.html +++ b/docs/dyn/compute_beta.resourcePolicies.html @@ -505,7 +505,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -519,7 +519,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -533,52 +532,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1141,7 +1094,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1157,7 +1109,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1171,7 +1123,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1185,52 +1136,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1245,7 +1150,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1259,7 +1164,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1273,52 +1177,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.serviceAttachments.html b/docs/dyn/compute_beta.serviceAttachments.html index 48b6be47fa..c6094042ab 100644 --- a/docs/dyn/compute_beta.serviceAttachments.html +++ b/docs/dyn/compute_beta.serviceAttachments.html @@ -448,7 +448,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -462,7 +462,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -476,52 +475,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -998,7 +951,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1014,7 +966,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1028,7 +980,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1042,52 +993,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1102,7 +1007,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1116,7 +1021,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1130,52 +1034,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.snapshots.html b/docs/dyn/compute_beta.snapshots.html index 1e86cf5edd..7b796790fd 100644 --- a/docs/dyn/compute_beta.snapshots.html +++ b/docs/dyn/compute_beta.snapshots.html @@ -341,7 +341,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -355,7 +355,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -369,52 +368,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -756,7 +709,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -772,7 +724,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -786,7 +738,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -800,52 +751,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -860,7 +765,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -874,7 +779,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -888,52 +792,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.storagePools.html b/docs/dyn/compute_beta.storagePools.html index 60e3fe92de..e205bb95a5 100644 --- a/docs/dyn/compute_beta.storagePools.html +++ b/docs/dyn/compute_beta.storagePools.html @@ -447,7 +447,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -461,7 +461,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -475,52 +474,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -891,7 +844,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -907,7 +859,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -921,7 +873,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -935,52 +886,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -995,7 +900,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1009,7 +914,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1023,52 +927,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_beta.subnetworks.html b/docs/dyn/compute_beta.subnetworks.html index f0159a5f00..2726d98b43 100644 --- a/docs/dyn/compute_beta.subnetworks.html +++ b/docs/dyn/compute_beta.subnetworks.html @@ -580,7 +580,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -594,7 +594,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -608,52 +607,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1184,7 +1137,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1200,7 +1152,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1214,7 +1166,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1228,52 +1179,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1288,7 +1193,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1302,7 +1207,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1316,52 +1220,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.backendBuckets.html b/docs/dyn/compute_v1.backendBuckets.html index 51eab7cf67..97f6e9b8af 100644 --- a/docs/dyn/compute_v1.backendBuckets.html +++ b/docs/dyn/compute_v1.backendBuckets.html @@ -590,7 +590,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -604,7 +604,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -618,52 +617,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1276,7 +1229,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1292,7 +1244,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1306,7 +1258,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1320,52 +1271,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1380,7 +1285,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1394,7 +1299,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1408,52 +1312,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.backendServices.html b/docs/dyn/compute_v1.backendServices.html index 602b5b3891..92d5924869 100644 --- a/docs/dyn/compute_v1.backendServices.html +++ b/docs/dyn/compute_v1.backendServices.html @@ -482,6 +482,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", }, @@ -996,6 +1004,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", }, @@ -1073,7 +1089,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1087,7 +1103,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1101,52 +1116,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1349,6 +1318,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", }, @@ -1688,6 +1665,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", }, @@ -1926,6 +1911,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", }, @@ -2180,6 +2173,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", }, @@ -2452,7 +2453,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2468,7 +2468,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2482,7 +2482,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2496,52 +2495,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -2556,7 +2509,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2570,7 +2523,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2584,52 +2536,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -2995,6 +2901,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", }, diff --git a/docs/dyn/compute_v1.disks.html b/docs/dyn/compute_v1.disks.html index 62ab1c1efa..81b097187b 100644 --- a/docs/dyn/compute_v1.disks.html +++ b/docs/dyn/compute_v1.disks.html @@ -1066,7 +1066,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1080,7 +1080,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1094,52 +1093,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1833,7 +1786,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1849,7 +1801,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1863,7 +1815,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1877,52 +1828,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1937,7 +1842,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1951,7 +1856,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1965,52 +1869,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.firewallPolicies.html b/docs/dyn/compute_v1.firewallPolicies.html index a1e1dd4614..31776ecada 100644 --- a/docs/dyn/compute_v1.firewallPolicies.html +++ b/docs/dyn/compute_v1.firewallPolicies.html @@ -874,7 +874,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -888,7 +888,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -902,52 +901,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -2248,7 +2201,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2264,7 +2216,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2278,7 +2230,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2292,52 +2243,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -2352,7 +2257,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2366,7 +2271,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2380,52 +2284,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.globalNetworkEndpointGroups.html b/docs/dyn/compute_v1.globalNetworkEndpointGroups.html index fe1ea404d3..79646155b7 100644 --- a/docs/dyn/compute_v1.globalNetworkEndpointGroups.html +++ b/docs/dyn/compute_v1.globalNetworkEndpointGroups.html @@ -125,6 +125,7 @@

Method Details

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

Method Details

"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. "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. }, ], @@ -857,6 +859,7 @@

Method Details

"healthCheckService": "A String", }, "healthState": "A String", # Health state of the network endpoint determined based on the health checks configured. + "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; @@ -867,6 +870,7 @@

Method Details

"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. "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.images.html b/docs/dyn/compute_v1.images.html index 269c5511d8..4e76498081 100644 --- a/docs/dyn/compute_v1.images.html +++ b/docs/dyn/compute_v1.images.html @@ -640,7 +640,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -654,7 +654,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -668,52 +667,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1355,7 +1308,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1371,7 +1323,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1385,7 +1337,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1399,52 +1350,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1459,7 +1364,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1473,7 +1378,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1487,52 +1391,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.instanceGroupManagers.html b/docs/dyn/compute_v1.instanceGroupManagers.html index d5fa4312a0..98359bf3a7 100644 --- a/docs/dyn/compute_v1.instanceGroupManagers.html +++ b/docs/dyn/compute_v1.instanceGroupManagers.html @@ -358,6 +358,16 @@

Method Details

}, "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. + "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. + "instanceSelections": { # Named instance selections configuring properties that the group will use when creating new VMs. + "a_key": { + "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". + "A String", + ], + "rank": 42, # Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference. + }, + }, + }, "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy VM. @@ -367,7 +377,7 @@

Method Details

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -1256,6 +1266,16 @@

Method Details

}, "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. + "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. + "instanceSelections": { # Named instance selections configuring properties that the group will use when creating new VMs. + "a_key": { + "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". + "A String", + ], + "rank": 42, # Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference. + }, + }, + }, "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy VM. @@ -1265,7 +1285,7 @@

Method Details

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -1402,6 +1422,16 @@

Method Details

}, "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. + "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. + "instanceSelections": { # Named instance selections configuring properties that the group will use when creating new VMs. + "a_key": { + "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". + "A String", + ], + "rank": 42, # Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference. + }, + }, + }, "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy VM. @@ -1411,7 +1441,7 @@

Method Details

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -1677,6 +1707,16 @@

Method Details

}, "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. + "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. + "instanceSelections": { # Named instance selections configuring properties that the group will use when creating new VMs. + "a_key": { + "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". + "A String", + ], + "rank": 42, # Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference. + }, + }, + }, "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy VM. @@ -1686,7 +1726,7 @@

Method Details

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -1979,6 +2019,9 @@

Method Details

"a_key": "A String", }, }, + "propertiesFromFlexibilityPolicy": { # [Output Only] Instance properties selected for this instance resulting from InstanceFlexibilityPolicy. + "machineType": "A String", # The machine type to be used for this instance. + }, "version": { # [Output Only] Intended version of this instance. "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. "name": "A String", # [Output Only] Name of the version. @@ -2160,6 +2203,16 @@

Method Details

}, "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. + "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. + "instanceSelections": { # Named instance selections configuring properties that the group will use when creating new VMs. + "a_key": { + "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". + "A String", + ], + "rank": 42, # Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference. + }, + }, + }, "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy VM. @@ -2169,7 +2222,7 @@

Method Details

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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.instanceTemplates.html b/docs/dyn/compute_v1.instanceTemplates.html index e9cc8ec290..943bcc8bca 100644 --- a/docs/dyn/compute_v1.instanceTemplates.html +++ b/docs/dyn/compute_v1.instanceTemplates.html @@ -891,7 +891,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -905,7 +905,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -919,52 +918,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1712,7 +1665,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1728,7 +1680,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1742,7 +1694,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1756,52 +1707,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1816,7 +1721,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1830,7 +1735,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1844,52 +1748,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html index f54b4ab280..9edaf3ac87 100644 --- a/docs/dyn/compute_v1.instances.html +++ b/docs/dyn/compute_v1.instances.html @@ -2253,12 +2253,12 @@

Method Details

An object of the form: { - "firewallPolicys": [ # Effective firewalls from firewall policies. + "firewallPolicys": [ # [Output Only] Effective firewalls from firewall policies. { "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy. "name": "A String", # [Output Only] The name of the firewall policy. "priority": 42, # [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. - "rules": [ # The rules that apply to the network. + "rules": [ # [Output Only] The rules that apply to the instance. Only rules that target the specific VM instance are returned if target service accounts or target secure tags are specified in the rules. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". "description": "A String", # An optional description for this resource. @@ -2445,7 +2445,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2459,7 +2459,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2473,52 +2472,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -4259,7 +4212,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -4275,7 +4227,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -4289,7 +4241,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -4303,52 +4254,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -4363,7 +4268,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -4377,7 +4282,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -4391,52 +4295,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.instantSnapshots.html b/docs/dyn/compute_v1.instantSnapshots.html index bf082c116b..0fd66c2a77 100644 --- a/docs/dyn/compute_v1.instantSnapshots.html +++ b/docs/dyn/compute_v1.instantSnapshots.html @@ -400,7 +400,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -414,7 +414,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -428,52 +427,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -724,7 +677,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -740,7 +692,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -754,7 +706,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -768,52 +719,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -828,7 +733,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -842,7 +747,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -856,52 +760,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.licenses.html b/docs/dyn/compute_v1.licenses.html index 45f55704e5..721f07030a 100644 --- a/docs/dyn/compute_v1.licenses.html +++ b/docs/dyn/compute_v1.licenses.html @@ -281,7 +281,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -295,7 +295,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -309,52 +308,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -581,7 +534,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -597,7 +549,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -611,7 +563,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -625,52 +576,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -685,7 +590,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -699,7 +604,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -713,52 +617,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.machineImages.html b/docs/dyn/compute_v1.machineImages.html index 688e98ff76..3e544640d1 100644 --- a/docs/dyn/compute_v1.machineImages.html +++ b/docs/dyn/compute_v1.machineImages.html @@ -721,7 +721,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -735,7 +735,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -749,52 +748,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1903,7 +1856,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1919,7 +1871,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1933,7 +1885,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1947,52 +1898,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -2007,7 +1912,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2021,7 +1926,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2035,52 +1939,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.networkAttachments.html b/docs/dyn/compute_v1.networkAttachments.html index ad38e2c04f..9b03c93f25 100644 --- a/docs/dyn/compute_v1.networkAttachments.html +++ b/docs/dyn/compute_v1.networkAttachments.html @@ -417,7 +417,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -431,7 +431,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -445,52 +444,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -925,7 +878,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -941,7 +893,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -955,7 +907,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -969,52 +920,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1029,7 +934,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1043,7 +948,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1057,52 +961,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.networkEndpointGroups.html b/docs/dyn/compute_v1.networkEndpointGroups.html index a8ae8c5112..f3fa2c3efd 100644 --- a/docs/dyn/compute_v1.networkEndpointGroups.html +++ b/docs/dyn/compute_v1.networkEndpointGroups.html @@ -246,6 +246,7 @@

Method Details

"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. "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. }, ], @@ -519,6 +520,7 @@

Method Details

"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. "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. }, ], @@ -991,6 +993,7 @@

Method Details

"healthCheckService": "A String", }, "healthState": "A String", # Health state of the network endpoint determined based on the health checks configured. + "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; @@ -1001,6 +1004,7 @@

Method Details

"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. "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.networkFirewallPolicies.html b/docs/dyn/compute_v1.networkFirewallPolicies.html index c8770355c0..af20147d9e 100644 --- a/docs/dyn/compute_v1.networkFirewallPolicies.html +++ b/docs/dyn/compute_v1.networkFirewallPolicies.html @@ -877,7 +877,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -891,7 +891,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -905,52 +904,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -2105,7 +2058,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2121,7 +2073,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2135,7 +2087,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2149,52 +2100,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -2209,7 +2114,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2223,7 +2128,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2237,52 +2141,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.networks.html b/docs/dyn/compute_v1.networks.html index b664b5eb54..1f9bf7bf38 100644 --- a/docs/dyn/compute_v1.networks.html +++ b/docs/dyn/compute_v1.networks.html @@ -465,12 +465,12 @@

Method Details

An object of the form: { - "firewallPolicys": [ # Effective firewalls from firewall policy. + "firewallPolicys": [ # [Output Only] Effective firewalls from firewall policy. It returns Global Network Firewall Policies and Hierarchical Firewall Policies. Use regionNetworkFirewallPolicies.getEffectiveFirewalls to get Regional Network Firewall Policies as well. { "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy. "name": "A String", # [Output Only] The name of the firewall policy. "priority": 42, # [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. - "rules": [ # The rules that apply to the network. + "rules": [ # [Output Only] The rules that apply to the network. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". "description": "A String", # An optional description for this resource. diff --git a/docs/dyn/compute_v1.nodeGroups.html b/docs/dyn/compute_v1.nodeGroups.html index 1393810a85..f7dddb650b 100644 --- a/docs/dyn/compute_v1.nodeGroups.html +++ b/docs/dyn/compute_v1.nodeGroups.html @@ -709,7 +709,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -723,7 +723,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -737,52 +736,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1469,7 +1422,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1485,7 +1437,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1499,7 +1451,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1513,52 +1464,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1573,7 +1478,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1587,7 +1492,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1601,52 +1505,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.nodeTemplates.html b/docs/dyn/compute_v1.nodeTemplates.html index 997a29f6d5..e1fac335e5 100644 --- a/docs/dyn/compute_v1.nodeTemplates.html +++ b/docs/dyn/compute_v1.nodeTemplates.html @@ -421,7 +421,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -435,7 +435,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -449,52 +448,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -769,7 +722,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -785,7 +737,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -799,7 +751,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -813,52 +764,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -873,7 +778,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -887,7 +792,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -901,52 +805,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.regionBackendServices.html b/docs/dyn/compute_v1.regionBackendServices.html index efa68236f2..1394a3537c 100644 --- a/docs/dyn/compute_v1.regionBackendServices.html +++ b/docs/dyn/compute_v1.regionBackendServices.html @@ -455,6 +455,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", }, @@ -534,7 +542,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -548,7 +556,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -562,52 +569,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -811,6 +772,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", }, @@ -1151,6 +1120,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", }, @@ -1390,6 +1367,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", }, @@ -1645,6 +1630,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", }, @@ -1787,7 +1780,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1803,7 +1795,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1817,7 +1809,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1831,52 +1822,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1891,7 +1836,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1905,7 +1850,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1919,52 +1863,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -2333,6 +2231,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", }, diff --git a/docs/dyn/compute_v1.regionCommitments.html b/docs/dyn/compute_v1.regionCommitments.html index cdf04e967d..206344d96e 100644 --- a/docs/dyn/compute_v1.regionCommitments.html +++ b/docs/dyn/compute_v1.regionCommitments.html @@ -218,7 +218,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -399,7 +399,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -525,7 +525,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -780,7 +780,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -936,7 +936,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], diff --git a/docs/dyn/compute_v1.regionDisks.html b/docs/dyn/compute_v1.regionDisks.html index dc048e1551..b51467afca 100644 --- a/docs/dyn/compute_v1.regionDisks.html +++ b/docs/dyn/compute_v1.regionDisks.html @@ -874,7 +874,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -888,7 +888,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -902,52 +901,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1641,7 +1594,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1657,7 +1609,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1671,7 +1623,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1685,52 +1636,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1745,7 +1650,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1759,7 +1664,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1773,52 +1677,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.regionInstanceGroupManagers.html b/docs/dyn/compute_v1.regionInstanceGroupManagers.html index 44a2c797d9..811dedeacf 100644 --- a/docs/dyn/compute_v1.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_v1.regionInstanceGroupManagers.html @@ -1044,6 +1044,16 @@

Method Details

}, "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. + "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. + "instanceSelections": { # Named instance selections configuring properties that the group will use when creating new VMs. + "a_key": { + "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". + "A String", + ], + "rank": 42, # Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference. + }, + }, + }, "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy VM. @@ -1053,7 +1063,7 @@

Method Details

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -1190,6 +1200,16 @@

Method Details

}, "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. + "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. + "instanceSelections": { # Named instance selections configuring properties that the group will use when creating new VMs. + "a_key": { + "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". + "A String", + ], + "rank": 42, # Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference. + }, + }, + }, "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy VM. @@ -1199,7 +1219,7 @@

Method Details

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -1465,6 +1485,16 @@

Method Details

}, "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. + "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. + "instanceSelections": { # Named instance selections configuring properties that the group will use when creating new VMs. + "a_key": { + "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". + "A String", + ], + "rank": 42, # Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference. + }, + }, + }, "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy VM. @@ -1474,7 +1504,7 @@

Method Details

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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. @@ -1767,6 +1797,9 @@

Method Details

"a_key": "A String", }, }, + "propertiesFromFlexibilityPolicy": { # [Output Only] Instance properties selected for this instance resulting from InstanceFlexibilityPolicy. + "machineType": "A String", # The machine type to be used for this instance. + }, "version": { # [Output Only] Intended version of this instance. "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. "name": "A String", # [Output Only] Name of the version. @@ -1948,6 +1981,16 @@

Method Details

}, "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. + "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. + "instanceSelections": { # Named instance selections configuring properties that the group will use when creating new VMs. + "a_key": { + "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". + "A String", + ], + "rank": 42, # Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference. + }, + }, + }, "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource. "instanceLifecyclePolicy": { # The repair policy for this managed instance group. "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy VM. @@ -1957,7 +2000,7 @@

Method Details

"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for this managed instance group. "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager. + "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. { # 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.regionInstantSnapshots.html b/docs/dyn/compute_v1.regionInstantSnapshots.html index 9602cbc3ad..a9033ed40c 100644 --- a/docs/dyn/compute_v1.regionInstantSnapshots.html +++ b/docs/dyn/compute_v1.regionInstantSnapshots.html @@ -297,7 +297,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -311,7 +311,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -325,52 +324,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -621,7 +574,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -637,7 +589,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -651,7 +603,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -665,52 +616,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -725,7 +630,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -739,7 +644,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -753,52 +657,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.regionNetworkEndpointGroups.html b/docs/dyn/compute_v1.regionNetworkEndpointGroups.html index 74a40539ed..6da822b040 100644 --- a/docs/dyn/compute_v1.regionNetworkEndpointGroups.html +++ b/docs/dyn/compute_v1.regionNetworkEndpointGroups.html @@ -126,6 +126,7 @@

Method Details

"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. "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. }, ], @@ -399,6 +400,7 @@

Method Details

"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. "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. }, ], @@ -864,6 +866,7 @@

Method Details

"healthCheckService": "A String", }, "healthState": "A String", # Health state of the network endpoint determined based on the health checks configured. + "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; @@ -874,6 +877,7 @@

Method Details

"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. "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.regionNetworkFirewallPolicies.html b/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html index 6dfae50e37..6ad087faba 100644 --- a/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html +++ b/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html @@ -885,11 +885,11 @@

Method Details

An object of the form: { - "firewallPolicys": [ # Effective firewalls from firewall policy. + "firewallPolicys": [ # [Output only] Effective firewalls from firewall policy. It applies to Regional Network Firewall Policies in the specified region, Global Network Firewall Policies and Hierachial Firewall Policies which are associated with the network. { "displayName": "A String", # [Output Only] The display name of the firewall policy. "name": "A String", # [Output Only] The name of the firewall policy. - "rules": [ # The rules that apply to the network. + "rules": [ # [Output only] The rules that apply to the network. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". "description": "A String", # An optional description for this resource. @@ -1039,7 +1039,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1053,7 +1053,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1067,52 +1066,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -2275,7 +2228,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2291,7 +2243,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2305,7 +2257,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2319,52 +2270,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -2379,7 +2284,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -2393,7 +2298,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -2407,52 +2311,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.reservations.html b/docs/dyn/compute_v1.reservations.html index 32f4a12c31..9318defb1d 100644 --- a/docs/dyn/compute_v1.reservations.html +++ b/docs/dyn/compute_v1.reservations.html @@ -209,7 +209,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -473,7 +473,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. } @@ -497,7 +497,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -511,7 +511,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -525,52 +524,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -654,7 +607,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. } @@ -867,7 +820,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. }, ], @@ -1047,7 +1000,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1063,7 +1015,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1077,7 +1029,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1091,52 +1042,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1151,7 +1056,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1165,7 +1070,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1179,52 +1083,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1341,7 +1199,7 @@

Method Details

"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate }, "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. - "status": "A String", # [Output Only] The status of the reservation. + "status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. } diff --git a/docs/dyn/compute_v1.resourcePolicies.html b/docs/dyn/compute_v1.resourcePolicies.html index 0169f26434..95c884b6ed 100644 --- a/docs/dyn/compute_v1.resourcePolicies.html +++ b/docs/dyn/compute_v1.resourcePolicies.html @@ -493,7 +493,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -507,7 +507,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -521,52 +520,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1111,7 +1064,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1127,7 +1079,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1141,7 +1093,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1155,52 +1106,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1215,7 +1120,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1229,7 +1134,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1243,52 +1147,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.serviceAttachments.html b/docs/dyn/compute_v1.serviceAttachments.html index da23b19887..0e4ea4d272 100644 --- a/docs/dyn/compute_v1.serviceAttachments.html +++ b/docs/dyn/compute_v1.serviceAttachments.html @@ -440,7 +440,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -454,7 +454,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -468,52 +467,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -978,7 +931,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -994,7 +946,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1008,7 +960,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1022,52 +973,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1082,7 +987,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1096,7 +1001,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1110,52 +1014,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.snapshots.html b/docs/dyn/compute_v1.snapshots.html index 64e8467b4c..baffc61fe8 100644 --- a/docs/dyn/compute_v1.snapshots.html +++ b/docs/dyn/compute_v1.snapshots.html @@ -337,7 +337,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -351,7 +351,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -365,52 +364,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -744,7 +697,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -760,7 +712,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -774,7 +726,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -788,52 +739,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -848,7 +753,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -862,7 +767,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -876,52 +780,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.storagePools.html b/docs/dyn/compute_v1.storagePools.html index e56e962529..ff2bdbd26b 100644 --- a/docs/dyn/compute_v1.storagePools.html +++ b/docs/dyn/compute_v1.storagePools.html @@ -447,7 +447,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -461,7 +461,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -475,52 +474,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -891,7 +844,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -907,7 +859,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -921,7 +873,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -935,52 +886,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -995,7 +900,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1009,7 +914,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1023,52 +927,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/compute_v1.subnetworks.html b/docs/dyn/compute_v1.subnetworks.html index 53f0e9cae6..3db6b983cd 100644 --- a/docs/dyn/compute_v1.subnetworks.html +++ b/docs/dyn/compute_v1.subnetworks.html @@ -578,7 +578,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -592,7 +592,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -606,52 +605,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } @@ -1178,7 +1131,6 @@

Method Details

{ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1194,7 +1146,7 @@

Method Details

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1208,7 +1160,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1222,52 +1173,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, } @@ -1282,7 +1187,7 @@

Method Details

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. @@ -1296,7 +1201,6 @@

Method Details

], "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. { # Associates `members`, or principals, with a `role`. - "bindingId": "A String", # This is deprecated and has no effect. Do not use. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. @@ -1310,52 +1214,6 @@

Method Details

}, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - "rules": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "action": "A String", # This is deprecated and has no effect. Do not use. - "conditions": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "iam": "A String", # This is deprecated and has no effect. Do not use. - "op": "A String", # This is deprecated and has no effect. Do not use. - "svc": "A String", # This is deprecated and has no effect. Do not use. - "sys": "A String", # This is deprecated and has no effect. Do not use. - "values": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], - "description": "A String", # This is deprecated and has no effect. Do not use. - "ins": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "logConfigs": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logName": "A String", # This is deprecated and has no effect. Do not use. - }, - "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "customFields": [ # This is deprecated and has no effect. Do not use. - { # This is deprecated and has no effect. Do not use. - "name": "A String", # This is deprecated and has no effect. Do not use. - "value": "A String", # This is deprecated and has no effect. Do not use. - }, - ], - "field": "A String", # This is deprecated and has no effect. Do not use. - "metric": "A String", # This is deprecated and has no effect. Do not use. - }, - "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. - "logMode": "A String", # This is deprecated and has no effect. Do not use. - }, - }, - ], - "notIns": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - "permissions": [ # This is deprecated and has no effect. Do not use. - "A String", - ], - }, - ], "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). } diff --git a/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html b/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html index 43a80086ff..6883116aad 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html @@ -250,6 +250,7 @@

Method Details

"parameter": "A String", # Name of the Parameter. }, ], + "inputSchemaAsString": "A String", # Output only. Input schema as string. "resultJsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this action's result metadata "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. @@ -297,6 +298,7 @@

Method Details

"nullable": True or False, # Specifies whether a null value is allowed. }, ], + "resultSchemaAsString": "A String", # Output only. Result schema as string. }, ], "nextPageToken": "A String", # token for next page diff --git a/docs/dyn/connectors_v1.projects.locations.connections.html b/docs/dyn/connectors_v1.projects.locations.connections.html index dc0bbb27ce..d93d72bf42 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.html @@ -2212,6 +2212,7 @@

Method Details

"parameter": "A String", # Name of the Parameter. }, ], + "inputSchemaAsString": "A String", # Output only. Input schema as string. "resultJsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this action's result metadata "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. @@ -2259,6 +2260,7 @@

Method Details

"nullable": True or False, # Specifies whether a null value is allowed. }, ], + "resultSchemaAsString": "A String", # Output only. Result schema as string. }, "connection": { # Connection represents an instance of connector. # Output only. Connection details "asyncOperationsEnabled": True or False, # Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API. diff --git a/docs/dyn/connectors_v1.projects.locations.connections.runtimeActionSchemas.html b/docs/dyn/connectors_v1.projects.locations.connections.runtimeActionSchemas.html index 9b37f45fd2..c3a6e21a25 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.runtimeActionSchemas.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.runtimeActionSchemas.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

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

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

List schema of a runtime actions filtered by action name.

list_next()

@@ -90,7 +90,7 @@

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, filter=None, pageSize=None, pageToken=None, schemaAsString=None, x__xgafv=None)
List schema of a runtime actions filtered by action name.
 
 Args:
@@ -98,6 +98,7 @@ 

Method Details

filter: string, Required. Filter Format: action="{actionId}" Only action field is supported with literal equality operator. Accepted filter example: action="CancelOrder" Wildcards are not supported in the filter currently. pageSize: integer, Page size. pageToken: string, Page token. + schemaAsString: boolean, Optional. Flag to indicate if schema should be returned as string or not x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -160,6 +161,7 @@

Method Details

"parameter": "A String", # Name of the Parameter. }, ], + "inputSchemaAsString": "A String", # Output only. Input schema as string. "resultJsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this action's result metadata "default": "", # The default value of the field or object described by this schema. "description": "A String", # A description of this schema. @@ -207,6 +209,7 @@

Method Details

"nullable": True or False, # Specifies whether a null value is allowed. }, ], + "resultSchemaAsString": "A String", # Output only. Result schema as string. }, ], }
diff --git a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html index 31cfade480..c99d760c8d 100644 --- a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html +++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html @@ -331,6 +331,7 @@

Method Details

"connectorInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector. "alwaysAllocateCpu": True or False, # Indicates that the Cloud Run CPU should always be allocated. "connectionRatelimitWindowSeconds": "A String", # The window used for ratelimiting runtime requests to connections. + "connectorVersioningEnabled": True or False, # Indicate whether connector versioning is enabled. "deploymentModel": "A String", # Indicate whether connector is deployed on GKE/CloudRun "hpaConfig": { # Autoscaling config for connector deployment system metrics. # HPA autoscaling config. "cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling. @@ -1101,6 +1102,7 @@

Method Details

"connectorInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector. "alwaysAllocateCpu": True or False, # Indicates that the Cloud Run CPU should always be allocated. "connectionRatelimitWindowSeconds": "A String", # The window used for ratelimiting runtime requests to connections. + "connectorVersioningEnabled": True or False, # Indicate whether connector versioning is enabled. "deploymentModel": "A String", # Indicate whether connector is deployed on GKE/CloudRun "hpaConfig": { # Autoscaling config for connector deployment system metrics. # HPA autoscaling config. "cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling. diff --git a/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html index dcc93c8157..14a63ddc57 100644 --- a/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html +++ b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html @@ -110,7 +110,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Message describing ContactCenter object Next ID: 23 +{ # Message describing ContactCenter object Next ID: 24 "adminUser": { # Message storing info about the first admin user. Next ID: 3 # Optional. Info about the first admin user, such as given name and family name. "familyName": "A String", # Optional. Last/family name of the first admin user. "givenName": "A String", # Optional. First/given name of the first admin user. @@ -284,7 +284,7 @@

Method Details

Returns: An object of the form: - { # Message describing ContactCenter object Next ID: 23 + { # Message describing ContactCenter object Next ID: 24 "adminUser": { # Message storing info about the first admin user. Next ID: 3 # Optional. Info about the first admin user, such as given name and family name. "familyName": "A String", # Optional. Last/family name of the first admin user. "givenName": "A String", # Optional. First/given name of the first admin user. @@ -398,7 +398,7 @@

Method Details

{ # Message for response to listing ContactCenters "contactCenters": [ # The list of ContactCenter - { # Message describing ContactCenter object Next ID: 23 + { # Message describing ContactCenter object Next ID: 24 "adminUser": { # Message storing info about the first admin user. Next ID: 3 # Optional. Info about the first admin user, such as given name and family name. "familyName": "A String", # Optional. Last/family name of the first admin user. "givenName": "A String", # Optional. First/given name of the first admin user. @@ -521,7 +521,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Message describing ContactCenter object Next ID: 23 +{ # Message describing ContactCenter object Next ID: 24 "adminUser": { # Message storing info about the first admin user. Next ID: 3 # Optional. Info about the first admin user, such as given name and family name. "familyName": "A String", # Optional. Last/family name of the first admin user. "givenName": "A String", # Optional. First/given name of the first admin user. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.analysisRules.html b/docs/dyn/contactcenterinsights_v1.projects.locations.analysisRules.html new file mode 100644 index 0000000000..5a47b22584 --- /dev/null +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.analysisRules.html @@ -0,0 +1,438 @@ + + + +

Contact Center AI Insights API . projects . locations . analysisRules

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a analysis rule.

+

+ delete(name, x__xgafv=None)

+

Deletes a analysis rule.

+

+ get(name, x__xgafv=None)

+

Get a analysis rule.

+

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

+

Lists analysis rules.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a analysis rule.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a analysis rule.
+
+Args:
+  parent: string, Required. The parent resource of the analysis rule. Required. The location to create a analysis rule for. Format: `projects//locations/` or `projects//locations/` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.
+  "active": True or False, # If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
+  "analysisPercentage": 3.14, # Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation.
+  "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO annotators will be run.
+    "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
+      "A String",
+    ],
+    "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
+      "A String",
+    ],
+    "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
+      "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
+        "qaScorecardRevisions": [ # List of QaScorecardRevisions.
+          "A String",
+        ],
+      },
+    },
+    "runEntityAnnotator": True or False, # Whether to run the entity annotator.
+    "runIntentAnnotator": True or False, # Whether to run the intent annotator.
+    "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
+    "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
+    "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
+    "runQaAnnotator": True or False, # Whether to run the QA annotator.
+    "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
+    "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
+    "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
+    "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
+      "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
+      "summarizationModel": "A String", # Default summarization model to be used.
+    },
+  },
+  "conversationFilter": "A String", # Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations.
+  "createTime": "A String", # Output only. The time at which this analysis rule was created.
+  "displayName": "A String", # Display Name of the analysis rule.
+  "name": "A String", # Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}
+  "updateTime": "A String", # Output only. The most recent time at which this analysis rule was updated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.
+  "active": True or False, # If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
+  "analysisPercentage": 3.14, # Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation.
+  "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO annotators will be run.
+    "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
+      "A String",
+    ],
+    "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
+      "A String",
+    ],
+    "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
+      "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
+        "qaScorecardRevisions": [ # List of QaScorecardRevisions.
+          "A String",
+        ],
+      },
+    },
+    "runEntityAnnotator": True or False, # Whether to run the entity annotator.
+    "runIntentAnnotator": True or False, # Whether to run the intent annotator.
+    "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
+    "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
+    "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
+    "runQaAnnotator": True or False, # Whether to run the QA annotator.
+    "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
+    "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
+    "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
+    "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
+      "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
+      "summarizationModel": "A String", # Default summarization model to be used.
+    },
+  },
+  "conversationFilter": "A String", # Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations.
+  "createTime": "A String", # Output only. The time at which this analysis rule was created.
+  "displayName": "A String", # Display Name of the analysis rule.
+  "name": "A String", # Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}
+  "updateTime": "A String", # Output only. The most recent time at which this analysis rule was updated.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a analysis rule.
+
+Args:
+  name: string, Required. The name of the analysis rule to delete. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Get a analysis rule.
+
+Args:
+  name: string, Required. The name of the AnalysisRule to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.
+  "active": True or False, # If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
+  "analysisPercentage": 3.14, # Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation.
+  "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO annotators will be run.
+    "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
+      "A String",
+    ],
+    "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
+      "A String",
+    ],
+    "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
+      "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
+        "qaScorecardRevisions": [ # List of QaScorecardRevisions.
+          "A String",
+        ],
+      },
+    },
+    "runEntityAnnotator": True or False, # Whether to run the entity annotator.
+    "runIntentAnnotator": True or False, # Whether to run the intent annotator.
+    "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
+    "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
+    "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
+    "runQaAnnotator": True or False, # Whether to run the QA annotator.
+    "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
+    "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
+    "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
+    "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
+      "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
+      "summarizationModel": "A String", # Default summarization model to be used.
+    },
+  },
+  "conversationFilter": "A String", # Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations.
+  "createTime": "A String", # Output only. The time at which this analysis rule was created.
+  "displayName": "A String", # Display Name of the analysis rule.
+  "name": "A String", # Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}
+  "updateTime": "A String", # Output only. The most recent time at which this analysis rule was updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists analysis rules.
+
+Args:
+  parent: string, Required. The parent resource of the analysis rules. (required)
+  pageSize: integer, Optional. The maximum number of analysis rule to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
+  pageToken: string, Optional. The value returned by the last `ListAnalysisRulesResponse`; indicates that this is a continuation of a prior `ListAnalysisRules` call and the system should return the next page of data.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response of listing views.
+  "analysisRules": [ # The analysis_rule that match the request.
+    { # The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.
+      "active": True or False, # If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
+      "analysisPercentage": 3.14, # Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation.
+      "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO annotators will be run.
+        "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
+          "A String",
+        ],
+        "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
+          "A String",
+        ],
+        "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
+          "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
+            "qaScorecardRevisions": [ # List of QaScorecardRevisions.
+              "A String",
+            ],
+          },
+        },
+        "runEntityAnnotator": True or False, # Whether to run the entity annotator.
+        "runIntentAnnotator": True or False, # Whether to run the intent annotator.
+        "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
+        "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
+        "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
+        "runQaAnnotator": True or False, # Whether to run the QA annotator.
+        "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
+        "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
+        "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
+        "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
+          "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
+          "summarizationModel": "A String", # Default summarization model to be used.
+        },
+      },
+      "conversationFilter": "A String", # Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations.
+      "createTime": "A String", # Output only. The time at which this analysis rule was created.
+      "displayName": "A String", # Display Name of the analysis rule.
+      "name": "A String", # Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}
+      "updateTime": "A String", # Output only. The most recent time at which this analysis rule was updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a analysis rule.
+
+Args:
+  name: string, Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.
+  "active": True or False, # If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
+  "analysisPercentage": 3.14, # Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation.
+  "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO annotators will be run.
+    "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
+      "A String",
+    ],
+    "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
+      "A String",
+    ],
+    "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
+      "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
+        "qaScorecardRevisions": [ # List of QaScorecardRevisions.
+          "A String",
+        ],
+      },
+    },
+    "runEntityAnnotator": True or False, # Whether to run the entity annotator.
+    "runIntentAnnotator": True or False, # Whether to run the intent annotator.
+    "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
+    "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
+    "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
+    "runQaAnnotator": True or False, # Whether to run the QA annotator.
+    "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
+    "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
+    "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
+    "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
+      "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
+      "summarizationModel": "A String", # Default summarization model to be used.
+    },
+  },
+  "conversationFilter": "A String", # Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations.
+  "createTime": "A String", # Output only. The time at which this analysis rule was created.
+  "displayName": "A String", # Display Name of the analysis rule.
+  "name": "A String", # Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}
+  "updateTime": "A String", # Output only. The most recent time at which this analysis rule was updated.
+}
+
+  updateMask: string, Optional. The list of fields to be updated. If the update_mask is not provided, the update will be applied to all fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.
+  "active": True or False, # If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
+  "analysisPercentage": 3.14, # Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation.
+  "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO annotators will be run.
+    "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
+      "A String",
+    ],
+    "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
+      "A String",
+    ],
+    "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
+      "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
+        "qaScorecardRevisions": [ # List of QaScorecardRevisions.
+          "A String",
+        ],
+      },
+    },
+    "runEntityAnnotator": True or False, # Whether to run the entity annotator.
+    "runIntentAnnotator": True or False, # Whether to run the intent annotator.
+    "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
+    "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
+    "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
+    "runQaAnnotator": True or False, # Whether to run the QA annotator.
+    "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
+    "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
+    "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
+    "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
+      "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
+      "summarizationModel": "A String", # Default summarization model to be used.
+    },
+  },
+  "conversationFilter": "A String", # Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations.
+  "createTime": "A String", # Output only. The time at which this analysis rule was created.
+  "displayName": "A String", # Display Name of the analysis rule.
+  "name": "A String", # Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}
+  "updateTime": "A String", # Output only. The most recent time at which this analysis rule was updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSet.authorizedView.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSet.authorizedView.html new file mode 100644 index 0000000000..74fcc998f0 --- /dev/null +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSet.authorizedView.html @@ -0,0 +1,209 @@ + + + +

Contact Center AI Insights API . projects . locations . authorizedViewSet . authorizedView

+

Instance Methods

+

+ calculateStats(location, filter=None, x__xgafv=None)

+

Gets conversation statistics.

+

+ close()

+

Close httplib2 connections.

+

+ queryMetrics(location, body=None, x__xgafv=None)

+

Query metrics.

+

Method Details

+
+ calculateStats(location, filter=None, x__xgafv=None) +
Gets conversation statistics.
+
+Args:
+  location: string, Required. The location of the conversations. (required)
+  filter: string, A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.
+  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 calculating conversation statistics.
+  "averageDuration": "A String", # The average duration of all conversations. The average is calculated using only conversations that have a time duration.
+  "averageTurnCount": 42, # The average number of turns per conversation.
+  "conversationCount": 42, # The total number of conversations.
+  "conversationCountTimeSeries": { # A time series representing conversations over time. # A time series representing the count of conversations created over time that match that requested filter criteria.
+    "intervalDuration": "A String", # The duration of each interval.
+    "points": [ # An ordered list of intervals from earliest to latest, where each interval represents the number of conversations that transpired during the time window.
+      { # A single interval in a time series.
+        "conversationCount": 42, # The number of conversations created in this interval.
+        "startTime": "A String", # The start time of this interval.
+      },
+    ],
+  },
+  "customHighlighterMatches": { # A map associating each custom highlighter resource name with its respective number of matches in the set of conversations.
+    "a_key": 42,
+  },
+  "issueMatches": { # A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: `projects//locations//issueModels//issues/` Deprecated, use `issue_matches_stats` field instead.
+    "a_key": 42,
+  },
+  "issueMatchesStats": { # A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: `projects//locations//issueModels//issues/`
+    "a_key": { # Aggregated statistics about an issue.
+      "displayName": "A String", # Display name of the issue.
+      "issue": "A String", # Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}
+      "labeledConversationsCount": "A String", # Number of conversations attached to the issue at this point in time.
+    },
+  },
+  "smartHighlighterMatches": { # A map associating each smart highlighter display name with its respective number of matches in the set of conversations.
+    "a_key": 42,
+  },
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ queryMetrics(location, body=None, x__xgafv=None) +
Query metrics.
+
+Args:
+  location: string, Required. The location of the data. "projects/{project}/locations/{location}" (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request for querying metrics.
+  "dimensions": [ # The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension's key must be unique. If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity. Up to one dimension is supported for now.
+    { # A dimension determines the grouping key for the query. In SQL terms, these would be part of both the "SELECT" and "GROUP BY" clauses.
+      "agentDimensionMetadata": { # Metadata about the agent dimension. # Output only. Metadata about the agent dimension.
+        "agentDisplayName": "A String", # Optional. The agent's name
+        "agentId": "A String", # Optional. A user-specified string representing the agent.
+        "agentTeam": "A String", # Optional. A user-specified string representing the agent's team.
+      },
+      "dimensionKey": "A String", # The key of the dimension.
+      "issueDimensionMetadata": { # Metadata about the issue dimension. # Output only. Metadata about the issue dimension.
+        "issueDisplayName": "A String", # The issue display name.
+        "issueId": "A String", # The issue ID.
+        "issueModelId": "A String", # The parent issue model ID.
+      },
+      "qaQuestionAnswerDimensionMetadata": { # Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard. # Output only. Metadata about the QA question-answer dimension.
+        "answerValue": "A String", # Optional. The full body of the question.
+        "qaQuestionId": "A String", # Optional. The QA question ID.
+        "qaScorecardId": "A String", # Optional. The QA scorecard ID.
+        "questionBody": "A String", # Optional. The full body of the question.
+      },
+      "qaQuestionDimensionMetadata": { # Metadata about the QA question dimension. # Output only. Metadata about the QA question dimension.
+        "qaQuestionId": "A String", # Optional. The QA question ID.
+        "qaScorecardId": "A String", # Optional. The QA scorecard ID.
+        "questionBody": "A String", # Optional. The full body of the question.
+      },
+    },
+  ],
+  "filter": "A String", # Required. Filter to select a subset of conversations to compute the metrics. Must specify a window of the conversation create time to compute the metrics. The returned metrics will be from the range [DATE(starting create time), DATE(ending create time)).
+  "measureMask": "A String", # Measures to return. Defaults to all measures if this field is unspecified. A valid mask should traverse from the `measure` field from the response. For example, a path from a measure mask to get the conversation count is "conversation_measure.count".
+  "timeGranularity": "A String", # The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.html new file mode 100644 index 0000000000..b2b774ee9f --- /dev/null +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.html @@ -0,0 +1,320 @@ + + + +

Contact Center AI Insights API . projects . locations . authorizedViewSet . authorizedViews . conversations . feedbackLabels

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Create feedback label.

+

+ delete(name, x__xgafv=None)

+

Delete feedback label.

+

+ get(name, x__xgafv=None)

+

Get feedback label.

+

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

+

List feedback labels.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update feedback label.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, feedbackLabelId=None, x__xgafv=None) +
Create feedback label.
+
+Args:
+  parent: string, Required. The parent resource of the feedback label. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a conversation, resource, and label provided by the user.
+  "createTime": "A String", # Output only. Create time of the label.
+  "label": "A String", # String label.
+  "labeledResource": "A String", # Resource name of the resource to be labeled.
+  "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
+  "qaAnswerLabel": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
+    "boolValue": True or False, # Boolean value.
+    "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+    "naValue": True or False, # A value of "Not Applicable (N/A)".
+    "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+    "numValue": 3.14, # Numerical value.
+    "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+    "score": 3.14, # Output only. Numerical score of the answer.
+    "strValue": "A String", # String value.
+  },
+  "updateTime": "A String", # Output only. Update time of the label.
+}
+
+  feedbackLabelId: string, Optional. The ID of the feedback label to create. If one is not specified it will be 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:
+
+    { # Represents a conversation, resource, and label provided by the user.
+  "createTime": "A String", # Output only. Create time of the label.
+  "label": "A String", # String label.
+  "labeledResource": "A String", # Resource name of the resource to be labeled.
+  "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
+  "qaAnswerLabel": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
+    "boolValue": True or False, # Boolean value.
+    "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+    "naValue": True or False, # A value of "Not Applicable (N/A)".
+    "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+    "numValue": 3.14, # Numerical value.
+    "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+    "score": 3.14, # Output only. Numerical score of the answer.
+    "strValue": "A String", # String value.
+  },
+  "updateTime": "A String", # Output only. Update time of the label.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Delete feedback label.
+
+Args:
+  name: string, Required. The name of the feedback label to delete. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Get feedback label.
+
+Args:
+  name: string, Required. The name of the feedback label to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a conversation, resource, and label provided by the user.
+  "createTime": "A String", # Output only. Create time of the label.
+  "label": "A String", # String label.
+  "labeledResource": "A String", # Resource name of the resource to be labeled.
+  "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
+  "qaAnswerLabel": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
+    "boolValue": True or False, # Boolean value.
+    "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+    "naValue": True or False, # A value of "Not Applicable (N/A)".
+    "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+    "numValue": 3.14, # Numerical value.
+    "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+    "score": 3.14, # Output only. Numerical score of the answer.
+    "strValue": "A String", # String value.
+  },
+  "updateTime": "A String", # Output only. Update time of the label.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
List feedback labels.
+
+Args:
+  parent: string, Required. The parent resource of the feedback labels. (required)
+  filter: string, Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
+  pageSize: integer, Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
+  pageToken: string, Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for listing feedback labels.
+  "feedbackLabels": [ # The feedback labels that match the request.
+    { # Represents a conversation, resource, and label provided by the user.
+      "createTime": "A String", # Output only. Create time of the label.
+      "label": "A String", # String label.
+      "labeledResource": "A String", # Resource name of the resource to be labeled.
+      "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
+      "qaAnswerLabel": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
+        "boolValue": True or False, # Boolean value.
+        "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+        "naValue": True or False, # A value of "Not Applicable (N/A)".
+        "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+        "numValue": 3.14, # Numerical value.
+        "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+        "score": 3.14, # Output only. Numerical score of the answer.
+        "strValue": "A String", # String value.
+      },
+      "updateTime": "A String", # Output only. Update time of the label.
+    },
+  ],
+  "nextPageToken": "A String", # The next page token.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Update feedback label.
+
+Args:
+  name: string, Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a conversation, resource, and label provided by the user.
+  "createTime": "A String", # Output only. Create time of the label.
+  "label": "A String", # String label.
+  "labeledResource": "A String", # Resource name of the resource to be labeled.
+  "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
+  "qaAnswerLabel": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
+    "boolValue": True or False, # Boolean value.
+    "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+    "naValue": True or False, # A value of "Not Applicable (N/A)".
+    "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+    "numValue": 3.14, # Numerical value.
+    "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+    "score": 3.14, # Output only. Numerical score of the answer.
+    "strValue": "A String", # String value.
+  },
+  "updateTime": "A String", # Output only. Update time of the label.
+}
+
+  updateMask: string, Required. The list of fields to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a conversation, resource, and label provided by the user.
+  "createTime": "A String", # Output only. Create time of the label.
+  "label": "A String", # String label.
+  "labeledResource": "A String", # Resource name of the resource to be labeled.
+  "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
+  "qaAnswerLabel": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
+    "boolValue": True or False, # Boolean value.
+    "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+    "naValue": True or False, # A value of "Not Applicable (N/A)".
+    "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+    "numValue": 3.14, # Numerical value.
+    "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+    "score": 3.14, # Output only. Numerical score of the answer.
+    "strValue": "A String", # String value.
+  },
+  "updateTime": "A String", # Output only. Update time of the label.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSet.authorizedViews.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSet.authorizedViews.conversations.html new file mode 100644 index 0000000000..3a70c0de47 --- /dev/null +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSet.authorizedViews.conversations.html @@ -0,0 +1,91 @@ + + + +

Contact Center AI Insights API . projects . locations . authorizedViewSet . authorizedViews . conversations

+

Instance Methods

+

+ feedbackLabels() +

+

Returns the feedbackLabels Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSet.authorizedViews.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSet.authorizedViews.html new file mode 100644 index 0000000000..4e73d34ea0 --- /dev/null +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSet.authorizedViews.html @@ -0,0 +1,91 @@ + + + +

Contact Center AI Insights API . projects . locations . authorizedViewSet . authorizedViews

+

Instance Methods

+

+ conversations() +

+

Returns the conversations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSet.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSet.html new file mode 100644 index 0000000000..7e1a29ae59 --- /dev/null +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSet.html @@ -0,0 +1,96 @@ + + + +

Contact Center AI Insights API . projects . locations . authorizedViewSet

+

Instance Methods

+

+ authorizedView() +

+

Returns the authorizedView Resource.

+ +

+ authorizedViews() +

+

Returns the authorizedViews Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.html new file mode 100644 index 0000000000..ec020de84f --- /dev/null +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.html @@ -0,0 +1,824 @@ + + + +

Contact Center AI Insights API . projects . locations . authorizedViewSets . authorizedViews . conversations . analyses

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates an analysis. The long running operation is done when the analysis has completed.

+

+ delete(name, x__xgafv=None)

+

Deletes an analysis.

+

+ get(name, x__xgafv=None)

+

Gets an analysis.

+

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

+

Lists analyses.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an analysis. The long running operation is done when the analysis has completed.
+
+Args:
+  parent: string, Required. The parent resource of the analysis. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The analysis resource.
+  "analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
+    "callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
+      "annotations": [ # A list of call annotations that apply to this call.
+        { # A piece of metadata that applies to a window of a call.
+          "annotationEndBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
+            "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+            "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+          },
+          "annotationStartBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
+            "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+            "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+          },
+          "channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
+          "entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
+            "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
+            "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+            "type": "A String", # The type of the entity mention.
+          },
+          "holdData": { # The data for a hold annotation. # Data specifying a hold.
+          },
+          "intentMatchData": { # The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences. # Data specifying an intent match.
+            "intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
+          },
+          "interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
+          },
+          "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
+            "issueAssignment": { # Information about the issue. # Information about the issue's assignment.
+              "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+              "issue": "A String", # Resource name of the assigned issue.
+              "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+            },
+          },
+          "phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
+            "displayName": "A String", # The human-readable name of the phrase matcher.
+            "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+          },
+          "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+            "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+            "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+          },
+          "silenceData": { # The data for a silence annotation. # Data specifying silence.
+          },
+        },
+      ],
+      "entities": { # All the entities in the call.
+        "a_key": { # The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.
+          "displayName": "A String", # The representative name for the entity.
+          "metadata": { # Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.
+            "a_key": "A String",
+          },
+          "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
+          "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
+            "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+            "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+          },
+          "type": "A String", # The entity type.
+        },
+      },
+      "intents": { # All the matched intents in the call.
+        "a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
+          "displayName": "A String", # The human-readable name of the intent.
+          "id": "A String", # The unique identifier of the intent.
+        },
+      },
+      "issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
+        "issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
+        "issues": [ # All the matched issues.
+          { # Information about the issue.
+            "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+            "issue": "A String", # Resource name of the assigned issue.
+            "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+          },
+        ],
+      },
+      "phraseMatchers": { # All the matched phrase matchers in the call.
+        "a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
+          "displayName": "A String", # The human-readable name of the phrase matcher.
+          "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+        },
+      },
+      "qaScorecardResults": [ # Results of scoring QaScorecards.
+        { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.
+          "agentId": "A String", # ID of the agent that handled the conversation.
+          "conversation": "A String", # The conversation scored by this result.
+          "createTime": "A String", # Output only. The timestamp that the revision was created.
+          "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}
+          "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.
+          "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+          "qaAnswers": [ # Set of QaAnswers represented in the result.
+            { # An answer to a QaQuestion.
+              "answerSources": [ # List of all individual answers given to the question.
+                { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.
+                  "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source.
+                    "boolValue": True or False, # Boolean value.
+                    "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                    "naValue": True or False, # A value of "Not Applicable (N/A)".
+                    "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                    "numValue": 3.14, # Numerical value.
+                    "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                    "score": 3.14, # Output only. Numerical score of the answer.
+                    "strValue": "A String", # String value.
+                  },
+                  "sourceType": "A String", # What created the answer.
+                },
+              ],
+              "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist.
+                "boolValue": True or False, # Boolean value.
+                "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                "naValue": True or False, # A value of "Not Applicable (N/A)".
+                "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                "numValue": 3.14, # Numerical value.
+                "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                "score": 3.14, # Output only. Numerical score of the answer.
+                "strValue": "A String", # String value.
+              },
+              "conversation": "A String", # The conversation the answer applies to.
+              "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead.
+              "qaQuestion": "A String", # The QaQuestion answered by this answer.
+              "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
+              "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.
+                "A String",
+              ],
+            },
+          ],
+          "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result.
+          "qaTagResults": [ # Collection of tags and their scores.
+            { # Tags and their corresponding results.
+              "normalizedScore": 3.14, # The normalized score the tag applies to.
+              "potentialScore": 3.14, # The potential score the tag applies to.
+              "score": 3.14, # The score the tag applies to.
+              "tag": "A String", # The tag the score applies to.
+            },
+          ],
+          "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist.
+          "scoreSources": [ # List of all individual score sets.
+            { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores.
+              "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score.
+              "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+              "qaTagResults": [ # Collection of tags and their scores.
+                { # Tags and their corresponding results.
+                  "normalizedScore": 3.14, # The normalized score the tag applies to.
+                  "potentialScore": 3.14, # The potential score the tag applies to.
+                  "score": 3.14, # The score the tag applies to.
+                  "tag": "A String", # The tag the score applies to.
+                },
+              ],
+              "score": 3.14, # The overall numerical score of the result.
+              "sourceType": "A String", # What created the score.
+            },
+          ],
+        },
+      ],
+      "sentiments": [ # Overall conversation-level sentiment for each channel of the call.
+        { # One channel of conversation-level sentiment data.
+          "channelTag": 42, # The channel of the audio that the data applies to.
+          "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+            "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+            "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+          },
+        },
+      ],
+      "silence": { # Conversation-level silence data. # Overall conversation-level silence during the call.
+        "silenceDuration": "A String", # Amount of time calculated to be in silence.
+        "silencePercentage": 3.14, # Percentage of the total conversation spent in silence.
+      },
+    },
+    "endTime": "A String", # The time at which the analysis ended.
+  },
+  "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
+    "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
+      "A String",
+    ],
+    "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
+      "A String",
+    ],
+    "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
+      "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
+        "qaScorecardRevisions": [ # List of QaScorecardRevisions.
+          "A String",
+        ],
+      },
+    },
+    "runEntityAnnotator": True or False, # Whether to run the entity annotator.
+    "runIntentAnnotator": True or False, # Whether to run the intent annotator.
+    "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
+    "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
+    "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
+    "runQaAnnotator": True or False, # Whether to run the QA annotator.
+    "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
+    "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
+    "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
+    "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
+      "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
+      "summarizationModel": "A String", # Default summarization model to be used.
+    },
+  },
+  "createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
+  "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
+  "requestTime": "A String", # Output only. The time at which the analysis was requested.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes an analysis.
+
+Args:
+  name: string, Required. The name of the analysis to delete. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets an analysis.
+
+Args:
+  name: string, Required. The name of the analysis to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The analysis resource.
+  "analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
+    "callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
+      "annotations": [ # A list of call annotations that apply to this call.
+        { # A piece of metadata that applies to a window of a call.
+          "annotationEndBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
+            "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+            "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+          },
+          "annotationStartBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
+            "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+            "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+          },
+          "channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
+          "entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
+            "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
+            "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+            "type": "A String", # The type of the entity mention.
+          },
+          "holdData": { # The data for a hold annotation. # Data specifying a hold.
+          },
+          "intentMatchData": { # The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences. # Data specifying an intent match.
+            "intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
+          },
+          "interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
+          },
+          "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
+            "issueAssignment": { # Information about the issue. # Information about the issue's assignment.
+              "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+              "issue": "A String", # Resource name of the assigned issue.
+              "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+            },
+          },
+          "phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
+            "displayName": "A String", # The human-readable name of the phrase matcher.
+            "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+          },
+          "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+            "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+            "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+          },
+          "silenceData": { # The data for a silence annotation. # Data specifying silence.
+          },
+        },
+      ],
+      "entities": { # All the entities in the call.
+        "a_key": { # The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.
+          "displayName": "A String", # The representative name for the entity.
+          "metadata": { # Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.
+            "a_key": "A String",
+          },
+          "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
+          "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
+            "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+            "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+          },
+          "type": "A String", # The entity type.
+        },
+      },
+      "intents": { # All the matched intents in the call.
+        "a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
+          "displayName": "A String", # The human-readable name of the intent.
+          "id": "A String", # The unique identifier of the intent.
+        },
+      },
+      "issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
+        "issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
+        "issues": [ # All the matched issues.
+          { # Information about the issue.
+            "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+            "issue": "A String", # Resource name of the assigned issue.
+            "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+          },
+        ],
+      },
+      "phraseMatchers": { # All the matched phrase matchers in the call.
+        "a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
+          "displayName": "A String", # The human-readable name of the phrase matcher.
+          "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+        },
+      },
+      "qaScorecardResults": [ # Results of scoring QaScorecards.
+        { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.
+          "agentId": "A String", # ID of the agent that handled the conversation.
+          "conversation": "A String", # The conversation scored by this result.
+          "createTime": "A String", # Output only. The timestamp that the revision was created.
+          "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}
+          "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.
+          "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+          "qaAnswers": [ # Set of QaAnswers represented in the result.
+            { # An answer to a QaQuestion.
+              "answerSources": [ # List of all individual answers given to the question.
+                { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.
+                  "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source.
+                    "boolValue": True or False, # Boolean value.
+                    "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                    "naValue": True or False, # A value of "Not Applicable (N/A)".
+                    "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                    "numValue": 3.14, # Numerical value.
+                    "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                    "score": 3.14, # Output only. Numerical score of the answer.
+                    "strValue": "A String", # String value.
+                  },
+                  "sourceType": "A String", # What created the answer.
+                },
+              ],
+              "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist.
+                "boolValue": True or False, # Boolean value.
+                "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                "naValue": True or False, # A value of "Not Applicable (N/A)".
+                "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                "numValue": 3.14, # Numerical value.
+                "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                "score": 3.14, # Output only. Numerical score of the answer.
+                "strValue": "A String", # String value.
+              },
+              "conversation": "A String", # The conversation the answer applies to.
+              "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead.
+              "qaQuestion": "A String", # The QaQuestion answered by this answer.
+              "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
+              "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.
+                "A String",
+              ],
+            },
+          ],
+          "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result.
+          "qaTagResults": [ # Collection of tags and their scores.
+            { # Tags and their corresponding results.
+              "normalizedScore": 3.14, # The normalized score the tag applies to.
+              "potentialScore": 3.14, # The potential score the tag applies to.
+              "score": 3.14, # The score the tag applies to.
+              "tag": "A String", # The tag the score applies to.
+            },
+          ],
+          "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist.
+          "scoreSources": [ # List of all individual score sets.
+            { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores.
+              "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score.
+              "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+              "qaTagResults": [ # Collection of tags and their scores.
+                { # Tags and their corresponding results.
+                  "normalizedScore": 3.14, # The normalized score the tag applies to.
+                  "potentialScore": 3.14, # The potential score the tag applies to.
+                  "score": 3.14, # The score the tag applies to.
+                  "tag": "A String", # The tag the score applies to.
+                },
+              ],
+              "score": 3.14, # The overall numerical score of the result.
+              "sourceType": "A String", # What created the score.
+            },
+          ],
+        },
+      ],
+      "sentiments": [ # Overall conversation-level sentiment for each channel of the call.
+        { # One channel of conversation-level sentiment data.
+          "channelTag": 42, # The channel of the audio that the data applies to.
+          "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+            "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+            "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+          },
+        },
+      ],
+      "silence": { # Conversation-level silence data. # Overall conversation-level silence during the call.
+        "silenceDuration": "A String", # Amount of time calculated to be in silence.
+        "silencePercentage": 3.14, # Percentage of the total conversation spent in silence.
+      },
+    },
+    "endTime": "A String", # The time at which the analysis ended.
+  },
+  "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
+    "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
+      "A String",
+    ],
+    "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
+      "A String",
+    ],
+    "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
+      "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
+        "qaScorecardRevisions": [ # List of QaScorecardRevisions.
+          "A String",
+        ],
+      },
+    },
+    "runEntityAnnotator": True or False, # Whether to run the entity annotator.
+    "runIntentAnnotator": True or False, # Whether to run the intent annotator.
+    "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
+    "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
+    "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
+    "runQaAnnotator": True or False, # Whether to run the QA annotator.
+    "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
+    "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
+    "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
+    "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
+      "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
+      "summarizationModel": "A String", # Default summarization model to be used.
+    },
+  },
+  "createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
+  "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
+  "requestTime": "A String", # Output only. The time at which the analysis was requested.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists analyses.
+
+Args:
+  parent: string, Required. The parent resource of the analyses. (required)
+  filter: string, A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.
+  pageSize: integer, The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
+  pageToken: string, The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response to list analyses.
+  "analyses": [ # The analyses that match the request.
+    { # The analysis resource.
+      "analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
+        "callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
+          "annotations": [ # A list of call annotations that apply to this call.
+            { # A piece of metadata that applies to a window of a call.
+              "annotationEndBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
+                "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+                "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+              },
+              "annotationStartBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
+                "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+                "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+              },
+              "channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
+              "entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
+                "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
+                "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
+                  "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+                  "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+                },
+                "type": "A String", # The type of the entity mention.
+              },
+              "holdData": { # The data for a hold annotation. # Data specifying a hold.
+              },
+              "intentMatchData": { # The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences. # Data specifying an intent match.
+                "intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
+              },
+              "interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
+              },
+              "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
+                "issueAssignment": { # Information about the issue. # Information about the issue's assignment.
+                  "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+                  "issue": "A String", # Resource name of the assigned issue.
+                  "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+                },
+              },
+              "phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
+                "displayName": "A String", # The human-readable name of the phrase matcher.
+                "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+              },
+              "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+                "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+                "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+              },
+              "silenceData": { # The data for a silence annotation. # Data specifying silence.
+              },
+            },
+          ],
+          "entities": { # All the entities in the call.
+            "a_key": { # The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.
+              "displayName": "A String", # The representative name for the entity.
+              "metadata": { # Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.
+                "a_key": "A String",
+              },
+              "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
+              "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
+                "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+                "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+              },
+              "type": "A String", # The entity type.
+            },
+          },
+          "intents": { # All the matched intents in the call.
+            "a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
+              "displayName": "A String", # The human-readable name of the intent.
+              "id": "A String", # The unique identifier of the intent.
+            },
+          },
+          "issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
+            "issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
+            "issues": [ # All the matched issues.
+              { # Information about the issue.
+                "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+                "issue": "A String", # Resource name of the assigned issue.
+                "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+              },
+            ],
+          },
+          "phraseMatchers": { # All the matched phrase matchers in the call.
+            "a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
+              "displayName": "A String", # The human-readable name of the phrase matcher.
+              "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+            },
+          },
+          "qaScorecardResults": [ # Results of scoring QaScorecards.
+            { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.
+              "agentId": "A String", # ID of the agent that handled the conversation.
+              "conversation": "A String", # The conversation scored by this result.
+              "createTime": "A String", # Output only. The timestamp that the revision was created.
+              "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}
+              "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.
+              "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+              "qaAnswers": [ # Set of QaAnswers represented in the result.
+                { # An answer to a QaQuestion.
+                  "answerSources": [ # List of all individual answers given to the question.
+                    { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.
+                      "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source.
+                        "boolValue": True or False, # Boolean value.
+                        "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                        "naValue": True or False, # A value of "Not Applicable (N/A)".
+                        "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                        "numValue": 3.14, # Numerical value.
+                        "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                        "score": 3.14, # Output only. Numerical score of the answer.
+                        "strValue": "A String", # String value.
+                      },
+                      "sourceType": "A String", # What created the answer.
+                    },
+                  ],
+                  "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist.
+                    "boolValue": True or False, # Boolean value.
+                    "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                    "naValue": True or False, # A value of "Not Applicable (N/A)".
+                    "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                    "numValue": 3.14, # Numerical value.
+                    "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                    "score": 3.14, # Output only. Numerical score of the answer.
+                    "strValue": "A String", # String value.
+                  },
+                  "conversation": "A String", # The conversation the answer applies to.
+                  "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead.
+                  "qaQuestion": "A String", # The QaQuestion answered by this answer.
+                  "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
+                  "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.
+                    "A String",
+                  ],
+                },
+              ],
+              "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result.
+              "qaTagResults": [ # Collection of tags and their scores.
+                { # Tags and their corresponding results.
+                  "normalizedScore": 3.14, # The normalized score the tag applies to.
+                  "potentialScore": 3.14, # The potential score the tag applies to.
+                  "score": 3.14, # The score the tag applies to.
+                  "tag": "A String", # The tag the score applies to.
+                },
+              ],
+              "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist.
+              "scoreSources": [ # List of all individual score sets.
+                { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores.
+                  "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score.
+                  "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+                  "qaTagResults": [ # Collection of tags and their scores.
+                    { # Tags and their corresponding results.
+                      "normalizedScore": 3.14, # The normalized score the tag applies to.
+                      "potentialScore": 3.14, # The potential score the tag applies to.
+                      "score": 3.14, # The score the tag applies to.
+                      "tag": "A String", # The tag the score applies to.
+                    },
+                  ],
+                  "score": 3.14, # The overall numerical score of the result.
+                  "sourceType": "A String", # What created the score.
+                },
+              ],
+            },
+          ],
+          "sentiments": [ # Overall conversation-level sentiment for each channel of the call.
+            { # One channel of conversation-level sentiment data.
+              "channelTag": 42, # The channel of the audio that the data applies to.
+              "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+                "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+                "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+              },
+            },
+          ],
+          "silence": { # Conversation-level silence data. # Overall conversation-level silence during the call.
+            "silenceDuration": "A String", # Amount of time calculated to be in silence.
+            "silencePercentage": 3.14, # Percentage of the total conversation spent in silence.
+          },
+        },
+        "endTime": "A String", # The time at which the analysis ended.
+      },
+      "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
+        "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
+          "A String",
+        ],
+        "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
+          "A String",
+        ],
+        "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
+          "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
+            "qaScorecardRevisions": [ # List of QaScorecardRevisions.
+              "A String",
+            ],
+          },
+        },
+        "runEntityAnnotator": True or False, # Whether to run the entity annotator.
+        "runIntentAnnotator": True or False, # Whether to run the intent annotator.
+        "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
+        "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
+        "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
+        "runQaAnnotator": True or False, # Whether to run the QA annotator.
+        "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
+        "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
+        "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
+        "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
+          "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
+          "summarizationModel": "A String", # Default summarization model to be used.
+        },
+      },
+      "createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
+      "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
+      "requestTime": "A String", # Output only. The time at which the analysis was requested.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html new file mode 100644 index 0000000000..bd23b8e51e --- /dev/null +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html @@ -0,0 +1,2906 @@ + + + +

Contact Center AI Insights API . projects . locations . authorizedViewSets . authorizedViews . conversations

+

Instance Methods

+

+ analyses() +

+

Returns the analyses Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead.

+

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

+

Deletes a conversation.

+

+ get(name, view=None, x__xgafv=None)

+

Gets a conversation.

+

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

+

Lists conversations.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a conversation.

+

+ upload(parent, body=None, conversationId=None, redactionConfig_deidentifyTemplate=None, redactionConfig_inspectTemplate=None, speechConfig_speechRecognizer=None, x__xgafv=None)

+

Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, conversationId=None, x__xgafv=None) +
Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead.
+
+Args:
+  parent: string, Required. The parent resource of the conversation. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The conversation resource.
+  "agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation.
+  "callMetadata": { # Call-specific metadata. # Call-specific metadata.
+    "agentChannel": 42, # The audio channel that contains the agent.
+    "customerChannel": 42, # The audio channel that contains the customer.
+  },
+  "createTime": "A String", # Output only. The time at which the conversation was created.
+  "dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation.
+    "dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow.
+      "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
+      "dialogflowConversation": "A String", # Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}
+    },
+    "gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript.
+      "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
+      "transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.
+    },
+  },
+  "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}
+    "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.
+      "displayName": "A String", # The human-readable name of the intent.
+    },
+  },
+  "duration": "A String", # Output only. The duration of the conversation.
+  "expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.
+  "labels": { # A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry.
+    "a_key": "A String",
+  },
+  "languageCode": "A String", # A user-specified language code for the conversation.
+  "latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists.
+    "analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
+      "callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
+        "annotations": [ # A list of call annotations that apply to this call.
+          { # A piece of metadata that applies to a window of a call.
+            "annotationEndBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
+              "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+              "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+            },
+            "annotationStartBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
+              "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+              "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+            },
+            "channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
+            "entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
+              "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
+              "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
+                "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+                "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+              },
+              "type": "A String", # The type of the entity mention.
+            },
+            "holdData": { # The data for a hold annotation. # Data specifying a hold.
+            },
+            "intentMatchData": { # The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences. # Data specifying an intent match.
+              "intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
+            },
+            "interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
+            },
+            "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
+              "issueAssignment": { # Information about the issue. # Information about the issue's assignment.
+                "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+                "issue": "A String", # Resource name of the assigned issue.
+                "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+              },
+            },
+            "phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
+              "displayName": "A String", # The human-readable name of the phrase matcher.
+              "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+            },
+            "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+            "silenceData": { # The data for a silence annotation. # Data specifying silence.
+            },
+          },
+        ],
+        "entities": { # All the entities in the call.
+          "a_key": { # The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.
+            "displayName": "A String", # The representative name for the entity.
+            "metadata": { # Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.
+              "a_key": "A String",
+            },
+            "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
+            "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+            "type": "A String", # The entity type.
+          },
+        },
+        "intents": { # All the matched intents in the call.
+          "a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
+            "displayName": "A String", # The human-readable name of the intent.
+            "id": "A String", # The unique identifier of the intent.
+          },
+        },
+        "issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
+          "issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
+          "issues": [ # All the matched issues.
+            { # Information about the issue.
+              "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+              "issue": "A String", # Resource name of the assigned issue.
+              "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+            },
+          ],
+        },
+        "phraseMatchers": { # All the matched phrase matchers in the call.
+          "a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
+            "displayName": "A String", # The human-readable name of the phrase matcher.
+            "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+          },
+        },
+        "qaScorecardResults": [ # Results of scoring QaScorecards.
+          { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.
+            "agentId": "A String", # ID of the agent that handled the conversation.
+            "conversation": "A String", # The conversation scored by this result.
+            "createTime": "A String", # Output only. The timestamp that the revision was created.
+            "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}
+            "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.
+            "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+            "qaAnswers": [ # Set of QaAnswers represented in the result.
+              { # An answer to a QaQuestion.
+                "answerSources": [ # List of all individual answers given to the question.
+                  { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.
+                    "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source.
+                      "boolValue": True or False, # Boolean value.
+                      "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                      "naValue": True or False, # A value of "Not Applicable (N/A)".
+                      "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                      "numValue": 3.14, # Numerical value.
+                      "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                      "score": 3.14, # Output only. Numerical score of the answer.
+                      "strValue": "A String", # String value.
+                    },
+                    "sourceType": "A String", # What created the answer.
+                  },
+                ],
+                "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist.
+                  "boolValue": True or False, # Boolean value.
+                  "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                  "naValue": True or False, # A value of "Not Applicable (N/A)".
+                  "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                  "numValue": 3.14, # Numerical value.
+                  "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                  "score": 3.14, # Output only. Numerical score of the answer.
+                  "strValue": "A String", # String value.
+                },
+                "conversation": "A String", # The conversation the answer applies to.
+                "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead.
+                "qaQuestion": "A String", # The QaQuestion answered by this answer.
+                "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
+                "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.
+                  "A String",
+                ],
+              },
+            ],
+            "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result.
+            "qaTagResults": [ # Collection of tags and their scores.
+              { # Tags and their corresponding results.
+                "normalizedScore": 3.14, # The normalized score the tag applies to.
+                "potentialScore": 3.14, # The potential score the tag applies to.
+                "score": 3.14, # The score the tag applies to.
+                "tag": "A String", # The tag the score applies to.
+              },
+            ],
+            "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist.
+            "scoreSources": [ # List of all individual score sets.
+              { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores.
+                "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score.
+                "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+                "qaTagResults": [ # Collection of tags and their scores.
+                  { # Tags and their corresponding results.
+                    "normalizedScore": 3.14, # The normalized score the tag applies to.
+                    "potentialScore": 3.14, # The potential score the tag applies to.
+                    "score": 3.14, # The score the tag applies to.
+                    "tag": "A String", # The tag the score applies to.
+                  },
+                ],
+                "score": 3.14, # The overall numerical score of the result.
+                "sourceType": "A String", # What created the score.
+              },
+            ],
+          },
+        ],
+        "sentiments": [ # Overall conversation-level sentiment for each channel of the call.
+          { # One channel of conversation-level sentiment data.
+            "channelTag": 42, # The channel of the audio that the data applies to.
+            "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+          },
+        ],
+        "silence": { # Conversation-level silence data. # Overall conversation-level silence during the call.
+          "silenceDuration": "A String", # Amount of time calculated to be in silence.
+          "silencePercentage": 3.14, # Percentage of the total conversation spent in silence.
+        },
+      },
+      "endTime": "A String", # The time at which the analysis ended.
+    },
+    "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
+      "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
+        "A String",
+      ],
+      "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
+        "A String",
+      ],
+      "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
+        "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
+          "qaScorecardRevisions": [ # List of QaScorecardRevisions.
+            "A String",
+          ],
+        },
+      },
+      "runEntityAnnotator": True or False, # Whether to run the entity annotator.
+      "runIntentAnnotator": True or False, # Whether to run the intent annotator.
+      "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
+      "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
+      "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
+      "runQaAnnotator": True or False, # Whether to run the QA annotator.
+      "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
+      "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
+      "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
+      "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
+        "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
+        "summarizationModel": "A String", # Default summarization model to be used.
+      },
+    },
+    "createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
+    "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
+    "requestTime": "A String", # Output only. The time at which the analysis was requested.
+  },
+  "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation.
+    "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+    "confidence": 3.14, # The confidence score of the summarization.
+    "conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
+    "metadata": { # A map that contains metadata about the summarization and the document from which it originates.
+      "a_key": "A String",
+    },
+    "text": "A String", # The summarization content that is concatenated into one string.
+    "textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
+      "a_key": "A String",
+    },
+  },
+  "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
+  "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.
+  "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
+  "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us.
+  "qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management.
+    "agentInfo": [ # Information about agents involved in the call.
+      { # Information about an agent involved in the conversation.
+        "agentId": "A String", # A user-specified string representing the agent.
+        "displayName": "A String", # The agent's name.
+        "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
+        "team": "A String", # A user-specified string representing the agent's team.
+      },
+    ],
+    "customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating.
+    "menuPath": "A String", # An arbitrary string value specifying the menu path the customer took.
+    "waitDuration": "A String", # The amount of time the customer waited to connect with an agent.
+  },
+  "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction.
+    { # An annotation that was generated during the customer and agent interaction.
+      "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}
+      "answerFeedback": { # The feedback that the customer has about a certain answer in the conversation. # The feedback that the customer has about the answer in `data`.
+        "clicked": True or False, # Indicates whether an answer or item was clicked by the human agent.
+        "correctnessLevel": "A String", # The correctness level of an answer.
+        "displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.
+      },
+      "articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data.
+        "confidenceScore": 3.14, # The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
+        "title": "A String", # Article title.
+        "uri": "A String", # Article URI.
+      },
+      "conversationSummarizationSuggestion": { # Conversation summarization suggestion data. # Conversation summarization suggestion data.
+        "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "confidence": 3.14, # The confidence score of the summarization.
+        "conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
+        "metadata": { # A map that contains metadata about the summarization and the document from which it originates.
+          "a_key": "A String",
+        },
+        "text": "A String", # The summarization content that is concatenated into one string.
+        "textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
+          "a_key": "A String",
+        },
+      },
+      "createTime": "A String", # The time at which this annotation was created.
+      "dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data.
+        "confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}
+      },
+      "endBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
+        "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+        "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+      },
+      "faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data.
+        "answer": "A String", # The piece of text from the `source` knowledge base document.
+        "confidenceScore": 3.14, # The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "question": "A String", # The corresponding FAQ question.
+        "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
+      },
+      "smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data.
+        "confidenceScore": 3.14, # The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "suggestion": "A String", # The content of the suggestion.
+      },
+      "smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data.
+        "confidenceScore": 3.14, # The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "reply": "A String", # The content of the reply.
+      },
+      "startBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
+        "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+        "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+      },
+      "userInput": { # Explicit input used for generating the answer # Explicit input used for generating the answer
+        "generatorName": "A String", # The resource name of associated generator. Format: `projects//locations//generators/`
+        "query": "A String", # Query text. Article Search uses this to store the input query used to generate the search results.
+        "querySource": "A String", # Query source for the answer.
+      },
+    },
+  ],
+  "startTime": "A String", # The time at which the conversation started.
+  "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript.
+    "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation.
+      { # A segment of a full transcript.
+        "channelTag": 42, # For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono.
+        "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.
+        "dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment.
+          "smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.
+        },
+        "languageCode": "A String", # The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US".
+        "messageTime": "A String", # The time that the message occurred, if provided.
+        "segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment.
+          "dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
+          "dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
+          "obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow.
+          "role": "A String", # The role of the participant.
+          "userId": "A String", # A user-specified ID representing the participant.
+        },
+        "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment.
+          "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+          "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+        },
+        "text": "A String", # The text of this segment.
+        "words": [ # A list of the word-specific information for each word in the segment.
+          { # Word-level info for words in a transcript.
+            "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.
+            "endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation.
+            "startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation.
+            "word": "A String", # The word itself. Includes punctuation marks that surround the word.
+          },
+        ],
+      },
+    ],
+  },
+  "ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.
+  "turnCount": 42, # Output only. The number of turns in the conversation.
+  "updateTime": "A String", # Output only. The most recent time at which the conversation was updated.
+}
+
+  conversationId: string, A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The conversation resource.
+  "agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation.
+  "callMetadata": { # Call-specific metadata. # Call-specific metadata.
+    "agentChannel": 42, # The audio channel that contains the agent.
+    "customerChannel": 42, # The audio channel that contains the customer.
+  },
+  "createTime": "A String", # Output only. The time at which the conversation was created.
+  "dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation.
+    "dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow.
+      "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
+      "dialogflowConversation": "A String", # Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}
+    },
+    "gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript.
+      "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
+      "transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.
+    },
+  },
+  "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}
+    "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.
+      "displayName": "A String", # The human-readable name of the intent.
+    },
+  },
+  "duration": "A String", # Output only. The duration of the conversation.
+  "expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.
+  "labels": { # A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry.
+    "a_key": "A String",
+  },
+  "languageCode": "A String", # A user-specified language code for the conversation.
+  "latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists.
+    "analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
+      "callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
+        "annotations": [ # A list of call annotations that apply to this call.
+          { # A piece of metadata that applies to a window of a call.
+            "annotationEndBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
+              "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+              "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+            },
+            "annotationStartBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
+              "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+              "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+            },
+            "channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
+            "entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
+              "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
+              "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
+                "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+                "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+              },
+              "type": "A String", # The type of the entity mention.
+            },
+            "holdData": { # The data for a hold annotation. # Data specifying a hold.
+            },
+            "intentMatchData": { # The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences. # Data specifying an intent match.
+              "intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
+            },
+            "interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
+            },
+            "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
+              "issueAssignment": { # Information about the issue. # Information about the issue's assignment.
+                "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+                "issue": "A String", # Resource name of the assigned issue.
+                "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+              },
+            },
+            "phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
+              "displayName": "A String", # The human-readable name of the phrase matcher.
+              "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+            },
+            "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+            "silenceData": { # The data for a silence annotation. # Data specifying silence.
+            },
+          },
+        ],
+        "entities": { # All the entities in the call.
+          "a_key": { # The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.
+            "displayName": "A String", # The representative name for the entity.
+            "metadata": { # Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.
+              "a_key": "A String",
+            },
+            "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
+            "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+            "type": "A String", # The entity type.
+          },
+        },
+        "intents": { # All the matched intents in the call.
+          "a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
+            "displayName": "A String", # The human-readable name of the intent.
+            "id": "A String", # The unique identifier of the intent.
+          },
+        },
+        "issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
+          "issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
+          "issues": [ # All the matched issues.
+            { # Information about the issue.
+              "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+              "issue": "A String", # Resource name of the assigned issue.
+              "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+            },
+          ],
+        },
+        "phraseMatchers": { # All the matched phrase matchers in the call.
+          "a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
+            "displayName": "A String", # The human-readable name of the phrase matcher.
+            "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+          },
+        },
+        "qaScorecardResults": [ # Results of scoring QaScorecards.
+          { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.
+            "agentId": "A String", # ID of the agent that handled the conversation.
+            "conversation": "A String", # The conversation scored by this result.
+            "createTime": "A String", # Output only. The timestamp that the revision was created.
+            "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}
+            "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.
+            "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+            "qaAnswers": [ # Set of QaAnswers represented in the result.
+              { # An answer to a QaQuestion.
+                "answerSources": [ # List of all individual answers given to the question.
+                  { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.
+                    "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source.
+                      "boolValue": True or False, # Boolean value.
+                      "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                      "naValue": True or False, # A value of "Not Applicable (N/A)".
+                      "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                      "numValue": 3.14, # Numerical value.
+                      "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                      "score": 3.14, # Output only. Numerical score of the answer.
+                      "strValue": "A String", # String value.
+                    },
+                    "sourceType": "A String", # What created the answer.
+                  },
+                ],
+                "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist.
+                  "boolValue": True or False, # Boolean value.
+                  "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                  "naValue": True or False, # A value of "Not Applicable (N/A)".
+                  "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                  "numValue": 3.14, # Numerical value.
+                  "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                  "score": 3.14, # Output only. Numerical score of the answer.
+                  "strValue": "A String", # String value.
+                },
+                "conversation": "A String", # The conversation the answer applies to.
+                "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead.
+                "qaQuestion": "A String", # The QaQuestion answered by this answer.
+                "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
+                "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.
+                  "A String",
+                ],
+              },
+            ],
+            "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result.
+            "qaTagResults": [ # Collection of tags and their scores.
+              { # Tags and their corresponding results.
+                "normalizedScore": 3.14, # The normalized score the tag applies to.
+                "potentialScore": 3.14, # The potential score the tag applies to.
+                "score": 3.14, # The score the tag applies to.
+                "tag": "A String", # The tag the score applies to.
+              },
+            ],
+            "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist.
+            "scoreSources": [ # List of all individual score sets.
+              { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores.
+                "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score.
+                "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+                "qaTagResults": [ # Collection of tags and their scores.
+                  { # Tags and their corresponding results.
+                    "normalizedScore": 3.14, # The normalized score the tag applies to.
+                    "potentialScore": 3.14, # The potential score the tag applies to.
+                    "score": 3.14, # The score the tag applies to.
+                    "tag": "A String", # The tag the score applies to.
+                  },
+                ],
+                "score": 3.14, # The overall numerical score of the result.
+                "sourceType": "A String", # What created the score.
+              },
+            ],
+          },
+        ],
+        "sentiments": [ # Overall conversation-level sentiment for each channel of the call.
+          { # One channel of conversation-level sentiment data.
+            "channelTag": 42, # The channel of the audio that the data applies to.
+            "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+          },
+        ],
+        "silence": { # Conversation-level silence data. # Overall conversation-level silence during the call.
+          "silenceDuration": "A String", # Amount of time calculated to be in silence.
+          "silencePercentage": 3.14, # Percentage of the total conversation spent in silence.
+        },
+      },
+      "endTime": "A String", # The time at which the analysis ended.
+    },
+    "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
+      "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
+        "A String",
+      ],
+      "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
+        "A String",
+      ],
+      "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
+        "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
+          "qaScorecardRevisions": [ # List of QaScorecardRevisions.
+            "A String",
+          ],
+        },
+      },
+      "runEntityAnnotator": True or False, # Whether to run the entity annotator.
+      "runIntentAnnotator": True or False, # Whether to run the intent annotator.
+      "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
+      "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
+      "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
+      "runQaAnnotator": True or False, # Whether to run the QA annotator.
+      "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
+      "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
+      "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
+      "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
+        "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
+        "summarizationModel": "A String", # Default summarization model to be used.
+      },
+    },
+    "createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
+    "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
+    "requestTime": "A String", # Output only. The time at which the analysis was requested.
+  },
+  "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation.
+    "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+    "confidence": 3.14, # The confidence score of the summarization.
+    "conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
+    "metadata": { # A map that contains metadata about the summarization and the document from which it originates.
+      "a_key": "A String",
+    },
+    "text": "A String", # The summarization content that is concatenated into one string.
+    "textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
+      "a_key": "A String",
+    },
+  },
+  "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
+  "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.
+  "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
+  "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us.
+  "qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management.
+    "agentInfo": [ # Information about agents involved in the call.
+      { # Information about an agent involved in the conversation.
+        "agentId": "A String", # A user-specified string representing the agent.
+        "displayName": "A String", # The agent's name.
+        "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
+        "team": "A String", # A user-specified string representing the agent's team.
+      },
+    ],
+    "customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating.
+    "menuPath": "A String", # An arbitrary string value specifying the menu path the customer took.
+    "waitDuration": "A String", # The amount of time the customer waited to connect with an agent.
+  },
+  "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction.
+    { # An annotation that was generated during the customer and agent interaction.
+      "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}
+      "answerFeedback": { # The feedback that the customer has about a certain answer in the conversation. # The feedback that the customer has about the answer in `data`.
+        "clicked": True or False, # Indicates whether an answer or item was clicked by the human agent.
+        "correctnessLevel": "A String", # The correctness level of an answer.
+        "displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.
+      },
+      "articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data.
+        "confidenceScore": 3.14, # The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
+        "title": "A String", # Article title.
+        "uri": "A String", # Article URI.
+      },
+      "conversationSummarizationSuggestion": { # Conversation summarization suggestion data. # Conversation summarization suggestion data.
+        "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "confidence": 3.14, # The confidence score of the summarization.
+        "conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
+        "metadata": { # A map that contains metadata about the summarization and the document from which it originates.
+          "a_key": "A String",
+        },
+        "text": "A String", # The summarization content that is concatenated into one string.
+        "textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
+          "a_key": "A String",
+        },
+      },
+      "createTime": "A String", # The time at which this annotation was created.
+      "dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data.
+        "confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}
+      },
+      "endBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
+        "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+        "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+      },
+      "faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data.
+        "answer": "A String", # The piece of text from the `source` knowledge base document.
+        "confidenceScore": 3.14, # The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "question": "A String", # The corresponding FAQ question.
+        "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
+      },
+      "smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data.
+        "confidenceScore": 3.14, # The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "suggestion": "A String", # The content of the suggestion.
+      },
+      "smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data.
+        "confidenceScore": 3.14, # The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "reply": "A String", # The content of the reply.
+      },
+      "startBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
+        "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+        "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+      },
+      "userInput": { # Explicit input used for generating the answer # Explicit input used for generating the answer
+        "generatorName": "A String", # The resource name of associated generator. Format: `projects//locations//generators/`
+        "query": "A String", # Query text. Article Search uses this to store the input query used to generate the search results.
+        "querySource": "A String", # Query source for the answer.
+      },
+    },
+  ],
+  "startTime": "A String", # The time at which the conversation started.
+  "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript.
+    "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation.
+      { # A segment of a full transcript.
+        "channelTag": 42, # For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono.
+        "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.
+        "dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment.
+          "smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.
+        },
+        "languageCode": "A String", # The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US".
+        "messageTime": "A String", # The time that the message occurred, if provided.
+        "segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment.
+          "dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
+          "dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
+          "obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow.
+          "role": "A String", # The role of the participant.
+          "userId": "A String", # A user-specified ID representing the participant.
+        },
+        "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment.
+          "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+          "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+        },
+        "text": "A String", # The text of this segment.
+        "words": [ # A list of the word-specific information for each word in the segment.
+          { # Word-level info for words in a transcript.
+            "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.
+            "endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation.
+            "startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation.
+            "word": "A String", # The word itself. Includes punctuation marks that surround the word.
+          },
+        ],
+      },
+    ],
+  },
+  "ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.
+  "turnCount": 42, # Output only. The number of turns in the conversation.
+  "updateTime": "A String", # Output only. The most recent time at which the conversation was updated.
+}
+
+ +
+ delete(name, force=None, x__xgafv=None) +
Deletes a conversation.
+
+Args:
+  name: string, Required. The name of the conversation to delete. (required)
+  force: boolean, If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, view=None, x__xgafv=None) +
Gets a conversation.
+
+Args:
+  name: string, Required. The name of the conversation to get. (required)
+  view: string, The level of details of the conversation. Default is `FULL`.
+    Allowed values
+      CONVERSATION_VIEW_UNSPECIFIED - The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.
+      FULL - Populates all fields in the conversation.
+      BASIC - Populates all fields in the conversation except the transcript.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The conversation resource.
+  "agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation.
+  "callMetadata": { # Call-specific metadata. # Call-specific metadata.
+    "agentChannel": 42, # The audio channel that contains the agent.
+    "customerChannel": 42, # The audio channel that contains the customer.
+  },
+  "createTime": "A String", # Output only. The time at which the conversation was created.
+  "dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation.
+    "dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow.
+      "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
+      "dialogflowConversation": "A String", # Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}
+    },
+    "gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript.
+      "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
+      "transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.
+    },
+  },
+  "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}
+    "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.
+      "displayName": "A String", # The human-readable name of the intent.
+    },
+  },
+  "duration": "A String", # Output only. The duration of the conversation.
+  "expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.
+  "labels": { # A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry.
+    "a_key": "A String",
+  },
+  "languageCode": "A String", # A user-specified language code for the conversation.
+  "latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists.
+    "analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
+      "callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
+        "annotations": [ # A list of call annotations that apply to this call.
+          { # A piece of metadata that applies to a window of a call.
+            "annotationEndBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
+              "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+              "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+            },
+            "annotationStartBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
+              "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+              "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+            },
+            "channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
+            "entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
+              "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
+              "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
+                "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+                "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+              },
+              "type": "A String", # The type of the entity mention.
+            },
+            "holdData": { # The data for a hold annotation. # Data specifying a hold.
+            },
+            "intentMatchData": { # The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences. # Data specifying an intent match.
+              "intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
+            },
+            "interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
+            },
+            "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
+              "issueAssignment": { # Information about the issue. # Information about the issue's assignment.
+                "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+                "issue": "A String", # Resource name of the assigned issue.
+                "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+              },
+            },
+            "phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
+              "displayName": "A String", # The human-readable name of the phrase matcher.
+              "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+            },
+            "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+            "silenceData": { # The data for a silence annotation. # Data specifying silence.
+            },
+          },
+        ],
+        "entities": { # All the entities in the call.
+          "a_key": { # The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.
+            "displayName": "A String", # The representative name for the entity.
+            "metadata": { # Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.
+              "a_key": "A String",
+            },
+            "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
+            "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+            "type": "A String", # The entity type.
+          },
+        },
+        "intents": { # All the matched intents in the call.
+          "a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
+            "displayName": "A String", # The human-readable name of the intent.
+            "id": "A String", # The unique identifier of the intent.
+          },
+        },
+        "issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
+          "issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
+          "issues": [ # All the matched issues.
+            { # Information about the issue.
+              "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+              "issue": "A String", # Resource name of the assigned issue.
+              "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+            },
+          ],
+        },
+        "phraseMatchers": { # All the matched phrase matchers in the call.
+          "a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
+            "displayName": "A String", # The human-readable name of the phrase matcher.
+            "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+          },
+        },
+        "qaScorecardResults": [ # Results of scoring QaScorecards.
+          { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.
+            "agentId": "A String", # ID of the agent that handled the conversation.
+            "conversation": "A String", # The conversation scored by this result.
+            "createTime": "A String", # Output only. The timestamp that the revision was created.
+            "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}
+            "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.
+            "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+            "qaAnswers": [ # Set of QaAnswers represented in the result.
+              { # An answer to a QaQuestion.
+                "answerSources": [ # List of all individual answers given to the question.
+                  { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.
+                    "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source.
+                      "boolValue": True or False, # Boolean value.
+                      "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                      "naValue": True or False, # A value of "Not Applicable (N/A)".
+                      "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                      "numValue": 3.14, # Numerical value.
+                      "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                      "score": 3.14, # Output only. Numerical score of the answer.
+                      "strValue": "A String", # String value.
+                    },
+                    "sourceType": "A String", # What created the answer.
+                  },
+                ],
+                "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist.
+                  "boolValue": True or False, # Boolean value.
+                  "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                  "naValue": True or False, # A value of "Not Applicable (N/A)".
+                  "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                  "numValue": 3.14, # Numerical value.
+                  "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                  "score": 3.14, # Output only. Numerical score of the answer.
+                  "strValue": "A String", # String value.
+                },
+                "conversation": "A String", # The conversation the answer applies to.
+                "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead.
+                "qaQuestion": "A String", # The QaQuestion answered by this answer.
+                "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
+                "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.
+                  "A String",
+                ],
+              },
+            ],
+            "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result.
+            "qaTagResults": [ # Collection of tags and their scores.
+              { # Tags and their corresponding results.
+                "normalizedScore": 3.14, # The normalized score the tag applies to.
+                "potentialScore": 3.14, # The potential score the tag applies to.
+                "score": 3.14, # The score the tag applies to.
+                "tag": "A String", # The tag the score applies to.
+              },
+            ],
+            "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist.
+            "scoreSources": [ # List of all individual score sets.
+              { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores.
+                "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score.
+                "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+                "qaTagResults": [ # Collection of tags and their scores.
+                  { # Tags and their corresponding results.
+                    "normalizedScore": 3.14, # The normalized score the tag applies to.
+                    "potentialScore": 3.14, # The potential score the tag applies to.
+                    "score": 3.14, # The score the tag applies to.
+                    "tag": "A String", # The tag the score applies to.
+                  },
+                ],
+                "score": 3.14, # The overall numerical score of the result.
+                "sourceType": "A String", # What created the score.
+              },
+            ],
+          },
+        ],
+        "sentiments": [ # Overall conversation-level sentiment for each channel of the call.
+          { # One channel of conversation-level sentiment data.
+            "channelTag": 42, # The channel of the audio that the data applies to.
+            "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+          },
+        ],
+        "silence": { # Conversation-level silence data. # Overall conversation-level silence during the call.
+          "silenceDuration": "A String", # Amount of time calculated to be in silence.
+          "silencePercentage": 3.14, # Percentage of the total conversation spent in silence.
+        },
+      },
+      "endTime": "A String", # The time at which the analysis ended.
+    },
+    "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
+      "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
+        "A String",
+      ],
+      "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
+        "A String",
+      ],
+      "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
+        "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
+          "qaScorecardRevisions": [ # List of QaScorecardRevisions.
+            "A String",
+          ],
+        },
+      },
+      "runEntityAnnotator": True or False, # Whether to run the entity annotator.
+      "runIntentAnnotator": True or False, # Whether to run the intent annotator.
+      "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
+      "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
+      "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
+      "runQaAnnotator": True or False, # Whether to run the QA annotator.
+      "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
+      "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
+      "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
+      "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
+        "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
+        "summarizationModel": "A String", # Default summarization model to be used.
+      },
+    },
+    "createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
+    "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
+    "requestTime": "A String", # Output only. The time at which the analysis was requested.
+  },
+  "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation.
+    "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+    "confidence": 3.14, # The confidence score of the summarization.
+    "conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
+    "metadata": { # A map that contains metadata about the summarization and the document from which it originates.
+      "a_key": "A String",
+    },
+    "text": "A String", # The summarization content that is concatenated into one string.
+    "textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
+      "a_key": "A String",
+    },
+  },
+  "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
+  "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.
+  "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
+  "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us.
+  "qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management.
+    "agentInfo": [ # Information about agents involved in the call.
+      { # Information about an agent involved in the conversation.
+        "agentId": "A String", # A user-specified string representing the agent.
+        "displayName": "A String", # The agent's name.
+        "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
+        "team": "A String", # A user-specified string representing the agent's team.
+      },
+    ],
+    "customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating.
+    "menuPath": "A String", # An arbitrary string value specifying the menu path the customer took.
+    "waitDuration": "A String", # The amount of time the customer waited to connect with an agent.
+  },
+  "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction.
+    { # An annotation that was generated during the customer and agent interaction.
+      "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}
+      "answerFeedback": { # The feedback that the customer has about a certain answer in the conversation. # The feedback that the customer has about the answer in `data`.
+        "clicked": True or False, # Indicates whether an answer or item was clicked by the human agent.
+        "correctnessLevel": "A String", # The correctness level of an answer.
+        "displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.
+      },
+      "articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data.
+        "confidenceScore": 3.14, # The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
+        "title": "A String", # Article title.
+        "uri": "A String", # Article URI.
+      },
+      "conversationSummarizationSuggestion": { # Conversation summarization suggestion data. # Conversation summarization suggestion data.
+        "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "confidence": 3.14, # The confidence score of the summarization.
+        "conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
+        "metadata": { # A map that contains metadata about the summarization and the document from which it originates.
+          "a_key": "A String",
+        },
+        "text": "A String", # The summarization content that is concatenated into one string.
+        "textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
+          "a_key": "A String",
+        },
+      },
+      "createTime": "A String", # The time at which this annotation was created.
+      "dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data.
+        "confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}
+      },
+      "endBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
+        "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+        "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+      },
+      "faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data.
+        "answer": "A String", # The piece of text from the `source` knowledge base document.
+        "confidenceScore": 3.14, # The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "question": "A String", # The corresponding FAQ question.
+        "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
+      },
+      "smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data.
+        "confidenceScore": 3.14, # The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "suggestion": "A String", # The content of the suggestion.
+      },
+      "smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data.
+        "confidenceScore": 3.14, # The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "reply": "A String", # The content of the reply.
+      },
+      "startBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
+        "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+        "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+      },
+      "userInput": { # Explicit input used for generating the answer # Explicit input used for generating the answer
+        "generatorName": "A String", # The resource name of associated generator. Format: `projects//locations//generators/`
+        "query": "A String", # Query text. Article Search uses this to store the input query used to generate the search results.
+        "querySource": "A String", # Query source for the answer.
+      },
+    },
+  ],
+  "startTime": "A String", # The time at which the conversation started.
+  "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript.
+    "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation.
+      { # A segment of a full transcript.
+        "channelTag": 42, # For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono.
+        "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.
+        "dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment.
+          "smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.
+        },
+        "languageCode": "A String", # The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US".
+        "messageTime": "A String", # The time that the message occurred, if provided.
+        "segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment.
+          "dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
+          "dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
+          "obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow.
+          "role": "A String", # The role of the participant.
+          "userId": "A String", # A user-specified ID representing the participant.
+        },
+        "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment.
+          "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+          "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+        },
+        "text": "A String", # The text of this segment.
+        "words": [ # A list of the word-specific information for each word in the segment.
+          { # Word-level info for words in a transcript.
+            "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.
+            "endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation.
+            "startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation.
+            "word": "A String", # The word itself. Includes punctuation marks that surround the word.
+          },
+        ],
+      },
+    ],
+  },
+  "ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.
+  "turnCount": 42, # Output only. The number of turns in the conversation.
+  "updateTime": "A String", # Output only. The most recent time at which the conversation was updated.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) +
Lists conversations.
+
+Args:
+  parent: string, Required. The parent resource of the conversation. (required)
+  filter: string, A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.
+  orderBy: string, Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).
+  pageSize: integer, The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
+  pageToken: string, The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.
+  view: string, The level of details of the conversation. Default is `BASIC`.
+    Allowed values
+      CONVERSATION_VIEW_UNSPECIFIED - The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.
+      FULL - Populates all fields in the conversation.
+      BASIC - Populates all fields in the conversation except the transcript.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response of listing conversations.
+  "conversations": [ # The conversations that match the request.
+    { # The conversation resource.
+      "agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation.
+      "callMetadata": { # Call-specific metadata. # Call-specific metadata.
+        "agentChannel": 42, # The audio channel that contains the agent.
+        "customerChannel": 42, # The audio channel that contains the customer.
+      },
+      "createTime": "A String", # Output only. The time at which the conversation was created.
+      "dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation.
+        "dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow.
+          "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
+          "dialogflowConversation": "A String", # Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}
+        },
+        "gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript.
+          "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
+          "transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.
+        },
+      },
+      "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}
+        "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.
+          "displayName": "A String", # The human-readable name of the intent.
+        },
+      },
+      "duration": "A String", # Output only. The duration of the conversation.
+      "expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.
+      "labels": { # A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry.
+        "a_key": "A String",
+      },
+      "languageCode": "A String", # A user-specified language code for the conversation.
+      "latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists.
+        "analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
+          "callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
+            "annotations": [ # A list of call annotations that apply to this call.
+              { # A piece of metadata that applies to a window of a call.
+                "annotationEndBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
+                  "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+                  "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+                },
+                "annotationStartBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
+                  "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+                  "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+                },
+                "channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
+                "entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
+                  "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
+                  "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
+                    "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+                    "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+                  },
+                  "type": "A String", # The type of the entity mention.
+                },
+                "holdData": { # The data for a hold annotation. # Data specifying a hold.
+                },
+                "intentMatchData": { # The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences. # Data specifying an intent match.
+                  "intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
+                },
+                "interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
+                },
+                "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
+                  "issueAssignment": { # Information about the issue. # Information about the issue's assignment.
+                    "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+                    "issue": "A String", # Resource name of the assigned issue.
+                    "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+                  },
+                },
+                "phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
+                  "displayName": "A String", # The human-readable name of the phrase matcher.
+                  "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+                },
+                "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+                  "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+                  "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+                },
+                "silenceData": { # The data for a silence annotation. # Data specifying silence.
+                },
+              },
+            ],
+            "entities": { # All the entities in the call.
+              "a_key": { # The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.
+                "displayName": "A String", # The representative name for the entity.
+                "metadata": { # Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.
+                  "a_key": "A String",
+                },
+                "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
+                "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
+                  "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+                  "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+                },
+                "type": "A String", # The entity type.
+              },
+            },
+            "intents": { # All the matched intents in the call.
+              "a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
+                "displayName": "A String", # The human-readable name of the intent.
+                "id": "A String", # The unique identifier of the intent.
+              },
+            },
+            "issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
+              "issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
+              "issues": [ # All the matched issues.
+                { # Information about the issue.
+                  "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+                  "issue": "A String", # Resource name of the assigned issue.
+                  "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+                },
+              ],
+            },
+            "phraseMatchers": { # All the matched phrase matchers in the call.
+              "a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
+                "displayName": "A String", # The human-readable name of the phrase matcher.
+                "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+              },
+            },
+            "qaScorecardResults": [ # Results of scoring QaScorecards.
+              { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.
+                "agentId": "A String", # ID of the agent that handled the conversation.
+                "conversation": "A String", # The conversation scored by this result.
+                "createTime": "A String", # Output only. The timestamp that the revision was created.
+                "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}
+                "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.
+                "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+                "qaAnswers": [ # Set of QaAnswers represented in the result.
+                  { # An answer to a QaQuestion.
+                    "answerSources": [ # List of all individual answers given to the question.
+                      { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.
+                        "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source.
+                          "boolValue": True or False, # Boolean value.
+                          "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                          "naValue": True or False, # A value of "Not Applicable (N/A)".
+                          "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                          "numValue": 3.14, # Numerical value.
+                          "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                          "score": 3.14, # Output only. Numerical score of the answer.
+                          "strValue": "A String", # String value.
+                        },
+                        "sourceType": "A String", # What created the answer.
+                      },
+                    ],
+                    "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist.
+                      "boolValue": True or False, # Boolean value.
+                      "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                      "naValue": True or False, # A value of "Not Applicable (N/A)".
+                      "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                      "numValue": 3.14, # Numerical value.
+                      "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                      "score": 3.14, # Output only. Numerical score of the answer.
+                      "strValue": "A String", # String value.
+                    },
+                    "conversation": "A String", # The conversation the answer applies to.
+                    "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead.
+                    "qaQuestion": "A String", # The QaQuestion answered by this answer.
+                    "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
+                    "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.
+                      "A String",
+                    ],
+                  },
+                ],
+                "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result.
+                "qaTagResults": [ # Collection of tags and their scores.
+                  { # Tags and their corresponding results.
+                    "normalizedScore": 3.14, # The normalized score the tag applies to.
+                    "potentialScore": 3.14, # The potential score the tag applies to.
+                    "score": 3.14, # The score the tag applies to.
+                    "tag": "A String", # The tag the score applies to.
+                  },
+                ],
+                "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist.
+                "scoreSources": [ # List of all individual score sets.
+                  { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores.
+                    "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score.
+                    "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+                    "qaTagResults": [ # Collection of tags and their scores.
+                      { # Tags and their corresponding results.
+                        "normalizedScore": 3.14, # The normalized score the tag applies to.
+                        "potentialScore": 3.14, # The potential score the tag applies to.
+                        "score": 3.14, # The score the tag applies to.
+                        "tag": "A String", # The tag the score applies to.
+                      },
+                    ],
+                    "score": 3.14, # The overall numerical score of the result.
+                    "sourceType": "A String", # What created the score.
+                  },
+                ],
+              },
+            ],
+            "sentiments": [ # Overall conversation-level sentiment for each channel of the call.
+              { # One channel of conversation-level sentiment data.
+                "channelTag": 42, # The channel of the audio that the data applies to.
+                "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+                  "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+                  "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+                },
+              },
+            ],
+            "silence": { # Conversation-level silence data. # Overall conversation-level silence during the call.
+              "silenceDuration": "A String", # Amount of time calculated to be in silence.
+              "silencePercentage": 3.14, # Percentage of the total conversation spent in silence.
+            },
+          },
+          "endTime": "A String", # The time at which the analysis ended.
+        },
+        "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
+          "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
+            "A String",
+          ],
+          "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
+            "A String",
+          ],
+          "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
+            "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
+              "qaScorecardRevisions": [ # List of QaScorecardRevisions.
+                "A String",
+              ],
+            },
+          },
+          "runEntityAnnotator": True or False, # Whether to run the entity annotator.
+          "runIntentAnnotator": True or False, # Whether to run the intent annotator.
+          "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
+          "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
+          "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
+          "runQaAnnotator": True or False, # Whether to run the QA annotator.
+          "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
+          "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
+          "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
+          "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
+            "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
+            "summarizationModel": "A String", # Default summarization model to be used.
+          },
+        },
+        "createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
+        "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
+        "requestTime": "A String", # Output only. The time at which the analysis was requested.
+      },
+      "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation.
+        "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "confidence": 3.14, # The confidence score of the summarization.
+        "conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
+        "metadata": { # A map that contains metadata about the summarization and the document from which it originates.
+          "a_key": "A String",
+        },
+        "text": "A String", # The summarization content that is concatenated into one string.
+        "textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
+          "a_key": "A String",
+        },
+      },
+      "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
+      "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.
+      "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
+      "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us.
+      "qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management.
+        "agentInfo": [ # Information about agents involved in the call.
+          { # Information about an agent involved in the conversation.
+            "agentId": "A String", # A user-specified string representing the agent.
+            "displayName": "A String", # The agent's name.
+            "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
+            "team": "A String", # A user-specified string representing the agent's team.
+          },
+        ],
+        "customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating.
+        "menuPath": "A String", # An arbitrary string value specifying the menu path the customer took.
+        "waitDuration": "A String", # The amount of time the customer waited to connect with an agent.
+      },
+      "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction.
+        { # An annotation that was generated during the customer and agent interaction.
+          "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}
+          "answerFeedback": { # The feedback that the customer has about a certain answer in the conversation. # The feedback that the customer has about the answer in `data`.
+            "clicked": True or False, # Indicates whether an answer or item was clicked by the human agent.
+            "correctnessLevel": "A String", # The correctness level of an answer.
+            "displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.
+          },
+          "articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data.
+            "confidenceScore": 3.14, # The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+            "metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from.
+              "a_key": "A String",
+            },
+            "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+            "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
+            "title": "A String", # Article title.
+            "uri": "A String", # Article URI.
+          },
+          "conversationSummarizationSuggestion": { # Conversation summarization suggestion data. # Conversation summarization suggestion data.
+            "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+            "confidence": 3.14, # The confidence score of the summarization.
+            "conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
+            "metadata": { # A map that contains metadata about the summarization and the document from which it originates.
+              "a_key": "A String",
+            },
+            "text": "A String", # The summarization content that is concatenated into one string.
+            "textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
+              "a_key": "A String",
+            },
+          },
+          "createTime": "A String", # The time at which this annotation was created.
+          "dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data.
+            "confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+            "dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}
+          },
+          "endBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
+            "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+            "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+          },
+          "faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data.
+            "answer": "A String", # The piece of text from the `source` knowledge base document.
+            "confidenceScore": 3.14, # The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+            "metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from.
+              "a_key": "A String",
+            },
+            "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+            "question": "A String", # The corresponding FAQ question.
+            "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
+          },
+          "smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data.
+            "confidenceScore": 3.14, # The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+            "metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates.
+              "a_key": "A String",
+            },
+            "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+            "suggestion": "A String", # The content of the suggestion.
+          },
+          "smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data.
+            "confidenceScore": 3.14, # The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+            "metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates.
+              "a_key": "A String",
+            },
+            "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+            "reply": "A String", # The content of the reply.
+          },
+          "startBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
+            "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+            "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+          },
+          "userInput": { # Explicit input used for generating the answer # Explicit input used for generating the answer
+            "generatorName": "A String", # The resource name of associated generator. Format: `projects//locations//generators/`
+            "query": "A String", # Query text. Article Search uses this to store the input query used to generate the search results.
+            "querySource": "A String", # Query source for the answer.
+          },
+        },
+      ],
+      "startTime": "A String", # The time at which the conversation started.
+      "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript.
+        "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation.
+          { # A segment of a full transcript.
+            "channelTag": 42, # For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono.
+            "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.
+            "dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment.
+              "smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.
+            },
+            "languageCode": "A String", # The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US".
+            "messageTime": "A String", # The time that the message occurred, if provided.
+            "segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment.
+              "dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
+              "dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
+              "obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow.
+              "role": "A String", # The role of the participant.
+              "userId": "A String", # A user-specified ID representing the participant.
+            },
+            "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+            "text": "A String", # The text of this segment.
+            "words": [ # A list of the word-specific information for each word in the segment.
+              { # Word-level info for words in a transcript.
+                "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.
+                "endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation.
+                "startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation.
+                "word": "A String", # The word itself. Includes punctuation marks that surround the word.
+              },
+            ],
+          },
+        ],
+      },
+      "ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.
+      "turnCount": 42, # Output only. The number of turns in the conversation.
+      "updateTime": "A String", # Output only. The most recent time at which the conversation was updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token which can be sent as `page_token` to retrieve the next page. If this field is set, it means there is another page available. If it is not set, it means no other pages are available.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a conversation.
+
+Args:
+  name: string, Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The conversation resource.
+  "agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation.
+  "callMetadata": { # Call-specific metadata. # Call-specific metadata.
+    "agentChannel": 42, # The audio channel that contains the agent.
+    "customerChannel": 42, # The audio channel that contains the customer.
+  },
+  "createTime": "A String", # Output only. The time at which the conversation was created.
+  "dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation.
+    "dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow.
+      "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
+      "dialogflowConversation": "A String", # Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}
+    },
+    "gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript.
+      "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
+      "transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.
+    },
+  },
+  "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}
+    "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.
+      "displayName": "A String", # The human-readable name of the intent.
+    },
+  },
+  "duration": "A String", # Output only. The duration of the conversation.
+  "expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.
+  "labels": { # A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry.
+    "a_key": "A String",
+  },
+  "languageCode": "A String", # A user-specified language code for the conversation.
+  "latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists.
+    "analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
+      "callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
+        "annotations": [ # A list of call annotations that apply to this call.
+          { # A piece of metadata that applies to a window of a call.
+            "annotationEndBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
+              "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+              "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+            },
+            "annotationStartBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
+              "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+              "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+            },
+            "channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
+            "entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
+              "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
+              "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
+                "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+                "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+              },
+              "type": "A String", # The type of the entity mention.
+            },
+            "holdData": { # The data for a hold annotation. # Data specifying a hold.
+            },
+            "intentMatchData": { # The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences. # Data specifying an intent match.
+              "intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
+            },
+            "interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
+            },
+            "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
+              "issueAssignment": { # Information about the issue. # Information about the issue's assignment.
+                "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+                "issue": "A String", # Resource name of the assigned issue.
+                "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+              },
+            },
+            "phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
+              "displayName": "A String", # The human-readable name of the phrase matcher.
+              "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+            },
+            "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+            "silenceData": { # The data for a silence annotation. # Data specifying silence.
+            },
+          },
+        ],
+        "entities": { # All the entities in the call.
+          "a_key": { # The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.
+            "displayName": "A String", # The representative name for the entity.
+            "metadata": { # Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.
+              "a_key": "A String",
+            },
+            "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
+            "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+            "type": "A String", # The entity type.
+          },
+        },
+        "intents": { # All the matched intents in the call.
+          "a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
+            "displayName": "A String", # The human-readable name of the intent.
+            "id": "A String", # The unique identifier of the intent.
+          },
+        },
+        "issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
+          "issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
+          "issues": [ # All the matched issues.
+            { # Information about the issue.
+              "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+              "issue": "A String", # Resource name of the assigned issue.
+              "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+            },
+          ],
+        },
+        "phraseMatchers": { # All the matched phrase matchers in the call.
+          "a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
+            "displayName": "A String", # The human-readable name of the phrase matcher.
+            "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+          },
+        },
+        "qaScorecardResults": [ # Results of scoring QaScorecards.
+          { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.
+            "agentId": "A String", # ID of the agent that handled the conversation.
+            "conversation": "A String", # The conversation scored by this result.
+            "createTime": "A String", # Output only. The timestamp that the revision was created.
+            "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}
+            "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.
+            "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+            "qaAnswers": [ # Set of QaAnswers represented in the result.
+              { # An answer to a QaQuestion.
+                "answerSources": [ # List of all individual answers given to the question.
+                  { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.
+                    "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source.
+                      "boolValue": True or False, # Boolean value.
+                      "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                      "naValue": True or False, # A value of "Not Applicable (N/A)".
+                      "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                      "numValue": 3.14, # Numerical value.
+                      "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                      "score": 3.14, # Output only. Numerical score of the answer.
+                      "strValue": "A String", # String value.
+                    },
+                    "sourceType": "A String", # What created the answer.
+                  },
+                ],
+                "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist.
+                  "boolValue": True or False, # Boolean value.
+                  "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                  "naValue": True or False, # A value of "Not Applicable (N/A)".
+                  "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                  "numValue": 3.14, # Numerical value.
+                  "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                  "score": 3.14, # Output only. Numerical score of the answer.
+                  "strValue": "A String", # String value.
+                },
+                "conversation": "A String", # The conversation the answer applies to.
+                "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead.
+                "qaQuestion": "A String", # The QaQuestion answered by this answer.
+                "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
+                "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.
+                  "A String",
+                ],
+              },
+            ],
+            "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result.
+            "qaTagResults": [ # Collection of tags and their scores.
+              { # Tags and their corresponding results.
+                "normalizedScore": 3.14, # The normalized score the tag applies to.
+                "potentialScore": 3.14, # The potential score the tag applies to.
+                "score": 3.14, # The score the tag applies to.
+                "tag": "A String", # The tag the score applies to.
+              },
+            ],
+            "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist.
+            "scoreSources": [ # List of all individual score sets.
+              { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores.
+                "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score.
+                "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+                "qaTagResults": [ # Collection of tags and their scores.
+                  { # Tags and their corresponding results.
+                    "normalizedScore": 3.14, # The normalized score the tag applies to.
+                    "potentialScore": 3.14, # The potential score the tag applies to.
+                    "score": 3.14, # The score the tag applies to.
+                    "tag": "A String", # The tag the score applies to.
+                  },
+                ],
+                "score": 3.14, # The overall numerical score of the result.
+                "sourceType": "A String", # What created the score.
+              },
+            ],
+          },
+        ],
+        "sentiments": [ # Overall conversation-level sentiment for each channel of the call.
+          { # One channel of conversation-level sentiment data.
+            "channelTag": 42, # The channel of the audio that the data applies to.
+            "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+          },
+        ],
+        "silence": { # Conversation-level silence data. # Overall conversation-level silence during the call.
+          "silenceDuration": "A String", # Amount of time calculated to be in silence.
+          "silencePercentage": 3.14, # Percentage of the total conversation spent in silence.
+        },
+      },
+      "endTime": "A String", # The time at which the analysis ended.
+    },
+    "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
+      "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
+        "A String",
+      ],
+      "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
+        "A String",
+      ],
+      "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
+        "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
+          "qaScorecardRevisions": [ # List of QaScorecardRevisions.
+            "A String",
+          ],
+        },
+      },
+      "runEntityAnnotator": True or False, # Whether to run the entity annotator.
+      "runIntentAnnotator": True or False, # Whether to run the intent annotator.
+      "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
+      "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
+      "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
+      "runQaAnnotator": True or False, # Whether to run the QA annotator.
+      "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
+      "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
+      "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
+      "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
+        "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
+        "summarizationModel": "A String", # Default summarization model to be used.
+      },
+    },
+    "createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
+    "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
+    "requestTime": "A String", # Output only. The time at which the analysis was requested.
+  },
+  "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation.
+    "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+    "confidence": 3.14, # The confidence score of the summarization.
+    "conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
+    "metadata": { # A map that contains metadata about the summarization and the document from which it originates.
+      "a_key": "A String",
+    },
+    "text": "A String", # The summarization content that is concatenated into one string.
+    "textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
+      "a_key": "A String",
+    },
+  },
+  "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
+  "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.
+  "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
+  "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us.
+  "qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management.
+    "agentInfo": [ # Information about agents involved in the call.
+      { # Information about an agent involved in the conversation.
+        "agentId": "A String", # A user-specified string representing the agent.
+        "displayName": "A String", # The agent's name.
+        "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
+        "team": "A String", # A user-specified string representing the agent's team.
+      },
+    ],
+    "customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating.
+    "menuPath": "A String", # An arbitrary string value specifying the menu path the customer took.
+    "waitDuration": "A String", # The amount of time the customer waited to connect with an agent.
+  },
+  "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction.
+    { # An annotation that was generated during the customer and agent interaction.
+      "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}
+      "answerFeedback": { # The feedback that the customer has about a certain answer in the conversation. # The feedback that the customer has about the answer in `data`.
+        "clicked": True or False, # Indicates whether an answer or item was clicked by the human agent.
+        "correctnessLevel": "A String", # The correctness level of an answer.
+        "displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.
+      },
+      "articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data.
+        "confidenceScore": 3.14, # The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
+        "title": "A String", # Article title.
+        "uri": "A String", # Article URI.
+      },
+      "conversationSummarizationSuggestion": { # Conversation summarization suggestion data. # Conversation summarization suggestion data.
+        "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "confidence": 3.14, # The confidence score of the summarization.
+        "conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
+        "metadata": { # A map that contains metadata about the summarization and the document from which it originates.
+          "a_key": "A String",
+        },
+        "text": "A String", # The summarization content that is concatenated into one string.
+        "textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
+          "a_key": "A String",
+        },
+      },
+      "createTime": "A String", # The time at which this annotation was created.
+      "dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data.
+        "confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}
+      },
+      "endBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
+        "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+        "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+      },
+      "faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data.
+        "answer": "A String", # The piece of text from the `source` knowledge base document.
+        "confidenceScore": 3.14, # The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "question": "A String", # The corresponding FAQ question.
+        "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
+      },
+      "smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data.
+        "confidenceScore": 3.14, # The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "suggestion": "A String", # The content of the suggestion.
+      },
+      "smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data.
+        "confidenceScore": 3.14, # The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "reply": "A String", # The content of the reply.
+      },
+      "startBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
+        "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+        "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+      },
+      "userInput": { # Explicit input used for generating the answer # Explicit input used for generating the answer
+        "generatorName": "A String", # The resource name of associated generator. Format: `projects//locations//generators/`
+        "query": "A String", # Query text. Article Search uses this to store the input query used to generate the search results.
+        "querySource": "A String", # Query source for the answer.
+      },
+    },
+  ],
+  "startTime": "A String", # The time at which the conversation started.
+  "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript.
+    "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation.
+      { # A segment of a full transcript.
+        "channelTag": 42, # For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono.
+        "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.
+        "dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment.
+          "smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.
+        },
+        "languageCode": "A String", # The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US".
+        "messageTime": "A String", # The time that the message occurred, if provided.
+        "segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment.
+          "dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
+          "dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
+          "obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow.
+          "role": "A String", # The role of the participant.
+          "userId": "A String", # A user-specified ID representing the participant.
+        },
+        "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment.
+          "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+          "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+        },
+        "text": "A String", # The text of this segment.
+        "words": [ # A list of the word-specific information for each word in the segment.
+          { # Word-level info for words in a transcript.
+            "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.
+            "endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation.
+            "startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation.
+            "word": "A String", # The word itself. Includes punctuation marks that surround the word.
+          },
+        ],
+      },
+    ],
+  },
+  "ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.
+  "turnCount": 42, # Output only. The number of turns in the conversation.
+  "updateTime": "A String", # Output only. The most recent time at which the conversation was updated.
+}
+
+  updateMask: string, The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or `data_source.dialogflow_source.audio_uri`
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The conversation resource.
+  "agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation.
+  "callMetadata": { # Call-specific metadata. # Call-specific metadata.
+    "agentChannel": 42, # The audio channel that contains the agent.
+    "customerChannel": 42, # The audio channel that contains the customer.
+  },
+  "createTime": "A String", # Output only. The time at which the conversation was created.
+  "dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation.
+    "dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow.
+      "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
+      "dialogflowConversation": "A String", # Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}
+    },
+    "gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript.
+      "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
+      "transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.
+    },
+  },
+  "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}
+    "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.
+      "displayName": "A String", # The human-readable name of the intent.
+    },
+  },
+  "duration": "A String", # Output only. The duration of the conversation.
+  "expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.
+  "labels": { # A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry.
+    "a_key": "A String",
+  },
+  "languageCode": "A String", # A user-specified language code for the conversation.
+  "latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists.
+    "analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
+      "callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
+        "annotations": [ # A list of call annotations that apply to this call.
+          { # A piece of metadata that applies to a window of a call.
+            "annotationEndBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
+              "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+              "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+            },
+            "annotationStartBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
+              "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+              "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+            },
+            "channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
+            "entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
+              "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
+              "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
+                "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+                "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+              },
+              "type": "A String", # The type of the entity mention.
+            },
+            "holdData": { # The data for a hold annotation. # Data specifying a hold.
+            },
+            "intentMatchData": { # The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences. # Data specifying an intent match.
+              "intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
+            },
+            "interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
+            },
+            "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
+              "issueAssignment": { # Information about the issue. # Information about the issue's assignment.
+                "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+                "issue": "A String", # Resource name of the assigned issue.
+                "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+              },
+            },
+            "phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
+              "displayName": "A String", # The human-readable name of the phrase matcher.
+              "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+            },
+            "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+            "silenceData": { # The data for a silence annotation. # Data specifying silence.
+            },
+          },
+        ],
+        "entities": { # All the entities in the call.
+          "a_key": { # The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.
+            "displayName": "A String", # The representative name for the entity.
+            "metadata": { # Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.
+              "a_key": "A String",
+            },
+            "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
+            "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+            "type": "A String", # The entity type.
+          },
+        },
+        "intents": { # All the matched intents in the call.
+          "a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
+            "displayName": "A String", # The human-readable name of the intent.
+            "id": "A String", # The unique identifier of the intent.
+          },
+        },
+        "issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
+          "issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
+          "issues": [ # All the matched issues.
+            { # Information about the issue.
+              "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+              "issue": "A String", # Resource name of the assigned issue.
+              "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+            },
+          ],
+        },
+        "phraseMatchers": { # All the matched phrase matchers in the call.
+          "a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
+            "displayName": "A String", # The human-readable name of the phrase matcher.
+            "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+          },
+        },
+        "qaScorecardResults": [ # Results of scoring QaScorecards.
+          { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.
+            "agentId": "A String", # ID of the agent that handled the conversation.
+            "conversation": "A String", # The conversation scored by this result.
+            "createTime": "A String", # Output only. The timestamp that the revision was created.
+            "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}
+            "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.
+            "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+            "qaAnswers": [ # Set of QaAnswers represented in the result.
+              { # An answer to a QaQuestion.
+                "answerSources": [ # List of all individual answers given to the question.
+                  { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.
+                    "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source.
+                      "boolValue": True or False, # Boolean value.
+                      "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                      "naValue": True or False, # A value of "Not Applicable (N/A)".
+                      "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                      "numValue": 3.14, # Numerical value.
+                      "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                      "score": 3.14, # Output only. Numerical score of the answer.
+                      "strValue": "A String", # String value.
+                    },
+                    "sourceType": "A String", # What created the answer.
+                  },
+                ],
+                "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist.
+                  "boolValue": True or False, # Boolean value.
+                  "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                  "naValue": True or False, # A value of "Not Applicable (N/A)".
+                  "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                  "numValue": 3.14, # Numerical value.
+                  "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                  "score": 3.14, # Output only. Numerical score of the answer.
+                  "strValue": "A String", # String value.
+                },
+                "conversation": "A String", # The conversation the answer applies to.
+                "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead.
+                "qaQuestion": "A String", # The QaQuestion answered by this answer.
+                "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
+                "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.
+                  "A String",
+                ],
+              },
+            ],
+            "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result.
+            "qaTagResults": [ # Collection of tags and their scores.
+              { # Tags and their corresponding results.
+                "normalizedScore": 3.14, # The normalized score the tag applies to.
+                "potentialScore": 3.14, # The potential score the tag applies to.
+                "score": 3.14, # The score the tag applies to.
+                "tag": "A String", # The tag the score applies to.
+              },
+            ],
+            "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist.
+            "scoreSources": [ # List of all individual score sets.
+              { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores.
+                "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score.
+                "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+                "qaTagResults": [ # Collection of tags and their scores.
+                  { # Tags and their corresponding results.
+                    "normalizedScore": 3.14, # The normalized score the tag applies to.
+                    "potentialScore": 3.14, # The potential score the tag applies to.
+                    "score": 3.14, # The score the tag applies to.
+                    "tag": "A String", # The tag the score applies to.
+                  },
+                ],
+                "score": 3.14, # The overall numerical score of the result.
+                "sourceType": "A String", # What created the score.
+              },
+            ],
+          },
+        ],
+        "sentiments": [ # Overall conversation-level sentiment for each channel of the call.
+          { # One channel of conversation-level sentiment data.
+            "channelTag": 42, # The channel of the audio that the data applies to.
+            "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+          },
+        ],
+        "silence": { # Conversation-level silence data. # Overall conversation-level silence during the call.
+          "silenceDuration": "A String", # Amount of time calculated to be in silence.
+          "silencePercentage": 3.14, # Percentage of the total conversation spent in silence.
+        },
+      },
+      "endTime": "A String", # The time at which the analysis ended.
+    },
+    "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
+      "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
+        "A String",
+      ],
+      "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
+        "A String",
+      ],
+      "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
+        "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
+          "qaScorecardRevisions": [ # List of QaScorecardRevisions.
+            "A String",
+          ],
+        },
+      },
+      "runEntityAnnotator": True or False, # Whether to run the entity annotator.
+      "runIntentAnnotator": True or False, # Whether to run the intent annotator.
+      "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
+      "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
+      "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
+      "runQaAnnotator": True or False, # Whether to run the QA annotator.
+      "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
+      "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
+      "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
+      "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
+        "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
+        "summarizationModel": "A String", # Default summarization model to be used.
+      },
+    },
+    "createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
+    "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
+    "requestTime": "A String", # Output only. The time at which the analysis was requested.
+  },
+  "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation.
+    "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+    "confidence": 3.14, # The confidence score of the summarization.
+    "conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
+    "metadata": { # A map that contains metadata about the summarization and the document from which it originates.
+      "a_key": "A String",
+    },
+    "text": "A String", # The summarization content that is concatenated into one string.
+    "textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
+      "a_key": "A String",
+    },
+  },
+  "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
+  "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.
+  "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
+  "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us.
+  "qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management.
+    "agentInfo": [ # Information about agents involved in the call.
+      { # Information about an agent involved in the conversation.
+        "agentId": "A String", # A user-specified string representing the agent.
+        "displayName": "A String", # The agent's name.
+        "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
+        "team": "A String", # A user-specified string representing the agent's team.
+      },
+    ],
+    "customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating.
+    "menuPath": "A String", # An arbitrary string value specifying the menu path the customer took.
+    "waitDuration": "A String", # The amount of time the customer waited to connect with an agent.
+  },
+  "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction.
+    { # An annotation that was generated during the customer and agent interaction.
+      "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}
+      "answerFeedback": { # The feedback that the customer has about a certain answer in the conversation. # The feedback that the customer has about the answer in `data`.
+        "clicked": True or False, # Indicates whether an answer or item was clicked by the human agent.
+        "correctnessLevel": "A String", # The correctness level of an answer.
+        "displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.
+      },
+      "articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data.
+        "confidenceScore": 3.14, # The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
+        "title": "A String", # Article title.
+        "uri": "A String", # Article URI.
+      },
+      "conversationSummarizationSuggestion": { # Conversation summarization suggestion data. # Conversation summarization suggestion data.
+        "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "confidence": 3.14, # The confidence score of the summarization.
+        "conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
+        "metadata": { # A map that contains metadata about the summarization and the document from which it originates.
+          "a_key": "A String",
+        },
+        "text": "A String", # The summarization content that is concatenated into one string.
+        "textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
+          "a_key": "A String",
+        },
+      },
+      "createTime": "A String", # The time at which this annotation was created.
+      "dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data.
+        "confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}
+      },
+      "endBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
+        "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+        "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+      },
+      "faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data.
+        "answer": "A String", # The piece of text from the `source` knowledge base document.
+        "confidenceScore": 3.14, # The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "question": "A String", # The corresponding FAQ question.
+        "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
+      },
+      "smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data.
+        "confidenceScore": 3.14, # The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "suggestion": "A String", # The content of the suggestion.
+      },
+      "smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data.
+        "confidenceScore": 3.14, # The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "reply": "A String", # The content of the reply.
+      },
+      "startBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
+        "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+        "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+      },
+      "userInput": { # Explicit input used for generating the answer # Explicit input used for generating the answer
+        "generatorName": "A String", # The resource name of associated generator. Format: `projects//locations//generators/`
+        "query": "A String", # Query text. Article Search uses this to store the input query used to generate the search results.
+        "querySource": "A String", # Query source for the answer.
+      },
+    },
+  ],
+  "startTime": "A String", # The time at which the conversation started.
+  "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript.
+    "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation.
+      { # A segment of a full transcript.
+        "channelTag": 42, # For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono.
+        "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.
+        "dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment.
+          "smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.
+        },
+        "languageCode": "A String", # The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US".
+        "messageTime": "A String", # The time that the message occurred, if provided.
+        "segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment.
+          "dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
+          "dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
+          "obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow.
+          "role": "A String", # The role of the participant.
+          "userId": "A String", # A user-specified ID representing the participant.
+        },
+        "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment.
+          "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+          "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+        },
+        "text": "A String", # The text of this segment.
+        "words": [ # A list of the word-specific information for each word in the segment.
+          { # Word-level info for words in a transcript.
+            "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.
+            "endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation.
+            "startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation.
+            "word": "A String", # The word itself. Includes punctuation marks that surround the word.
+          },
+        ],
+      },
+    ],
+  },
+  "ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.
+  "turnCount": 42, # Output only. The number of turns in the conversation.
+  "updateTime": "A String", # Output only. The most recent time at which the conversation was updated.
+}
+
+ +
+ upload(parent, body=None, conversationId=None, redactionConfig_deidentifyTemplate=None, redactionConfig_inspectTemplate=None, speechConfig_speechRecognizer=None, x__xgafv=None) +
Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction.
+
+Args:
+  parent: string, Required. The parent resource of the conversation. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The conversation resource.
+  "agentId": "A String", # An opaque, user-specified string representing the human agent who handled the conversation.
+  "callMetadata": { # Call-specific metadata. # Call-specific metadata.
+    "agentChannel": 42, # The audio channel that contains the agent.
+    "customerChannel": 42, # The audio channel that contains the customer.
+  },
+  "createTime": "A String", # Output only. The time at which the conversation was created.
+  "dataSource": { # The conversation source, which is a combination of transcript and audio. # The source of the audio and transcription for the conversation.
+    "dialogflowSource": { # A Dialogflow source of conversation data. # The source when the conversation comes from Dialogflow.
+      "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
+      "dialogflowConversation": "A String", # Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}
+    },
+    "gcsSource": { # A Cloud Storage source of conversation data. # A Cloud Storage location specification for the audio and transcript.
+      "audioUri": "A String", # Cloud Storage URI that points to a file that contains the conversation audio.
+      "transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.
+    },
+  },
+  "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}
+    "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.
+      "displayName": "A String", # The human-readable name of the intent.
+    },
+  },
+  "duration": "A String", # Output only. The duration of the conversation.
+  "expireTime": "A String", # The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.
+  "labels": { # A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry.
+    "a_key": "A String",
+  },
+  "languageCode": "A String", # A user-specified language code for the conversation.
+  "latestAnalysis": { # The analysis resource. # Output only. The conversation's latest analysis, if one exists.
+    "analysisResult": { # The result of an analysis. # Output only. The result of the analysis, which is populated when the analysis finishes.
+      "callAnalysisMetadata": { # Call-specific metadata created during analysis. # Call-specific metadata created by the analysis.
+        "annotations": [ # A list of call annotations that apply to this call.
+          { # A piece of metadata that applies to a window of a call.
+            "annotationEndBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
+              "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+              "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+            },
+            "annotationStartBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
+              "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+              "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+            },
+            "channelTag": 42, # The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
+            "entityMentionData": { # The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. # Data specifying an entity mention.
+              "entityUniqueId": "A String", # The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
+              "sentiment": { # The data for a sentiment annotation. # Sentiment expressed for this mention of the entity.
+                "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+                "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+              },
+              "type": "A String", # The type of the entity mention.
+            },
+            "holdData": { # The data for a hold annotation. # Data specifying a hold.
+            },
+            "intentMatchData": { # The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences. # Data specifying an intent match.
+              "intentUniqueId": "A String", # The id of the matched intent. Can be used to retrieve the corresponding intent information.
+            },
+            "interruptionData": { # The data for an interruption annotation. # Data specifying an interruption.
+            },
+            "issueMatchData": { # The data for an issue match annotation. # Data specifying an issue match.
+              "issueAssignment": { # Information about the issue. # Information about the issue's assignment.
+                "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+                "issue": "A String", # Resource name of the assigned issue.
+                "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+              },
+            },
+            "phraseMatchData": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. # Data specifying a phrase match.
+              "displayName": "A String", # The human-readable name of the phrase matcher.
+              "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+            },
+            "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+            "silenceData": { # The data for a silence annotation. # Data specifying silence.
+            },
+          },
+        ],
+        "entities": { # All the entities in the call.
+          "a_key": { # The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.
+            "displayName": "A String", # The representative name for the entity.
+            "metadata": { # Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.
+              "a_key": "A String",
+            },
+            "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
+            "sentiment": { # The data for a sentiment annotation. # The aggregate sentiment expressed for this entity in the conversation.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+            "type": "A String", # The entity type.
+          },
+        },
+        "intents": { # All the matched intents in the call.
+          "a_key": { # The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
+            "displayName": "A String", # The human-readable name of the intent.
+            "id": "A String", # The unique identifier of the intent.
+          },
+        },
+        "issueModelResult": { # Issue Modeling result on a conversation. # Overall conversation-level issue modeling result.
+          "issueModel": "A String", # Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}
+          "issues": [ # All the matched issues.
+            { # Information about the issue.
+              "displayName": "A String", # Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
+              "issue": "A String", # Resource name of the assigned issue.
+              "score": 3.14, # Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
+            },
+          ],
+        },
+        "phraseMatchers": { # All the matched phrase matchers in the call.
+          "a_key": { # The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
+            "displayName": "A String", # The human-readable name of the phrase matcher.
+            "phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher.
+          },
+        },
+        "qaScorecardResults": [ # Results of scoring QaScorecards.
+          { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.
+            "agentId": "A String", # ID of the agent that handled the conversation.
+            "conversation": "A String", # The conversation scored by this result.
+            "createTime": "A String", # Output only. The timestamp that the revision was created.
+            "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}
+            "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.
+            "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+            "qaAnswers": [ # Set of QaAnswers represented in the result.
+              { # An answer to a QaQuestion.
+                "answerSources": [ # List of all individual answers given to the question.
+                  { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.
+                    "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source.
+                      "boolValue": True or False, # Boolean value.
+                      "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                      "naValue": True or False, # A value of "Not Applicable (N/A)".
+                      "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                      "numValue": 3.14, # Numerical value.
+                      "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                      "score": 3.14, # Output only. Numerical score of the answer.
+                      "strValue": "A String", # String value.
+                    },
+                    "sourceType": "A String", # What created the answer.
+                  },
+                ],
+                "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist.
+                  "boolValue": True or False, # Boolean value.
+                  "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+                  "naValue": True or False, # A value of "Not Applicable (N/A)".
+                  "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+                  "numValue": 3.14, # Numerical value.
+                  "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+                  "score": 3.14, # Output only. Numerical score of the answer.
+                  "strValue": "A String", # String value.
+                },
+                "conversation": "A String", # The conversation the answer applies to.
+                "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead.
+                "qaQuestion": "A String", # The QaQuestion answered by this answer.
+                "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
+                "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.
+                  "A String",
+                ],
+              },
+            ],
+            "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result.
+            "qaTagResults": [ # Collection of tags and their scores.
+              { # Tags and their corresponding results.
+                "normalizedScore": 3.14, # The normalized score the tag applies to.
+                "potentialScore": 3.14, # The potential score the tag applies to.
+                "score": 3.14, # The score the tag applies to.
+                "tag": "A String", # The tag the score applies to.
+              },
+            ],
+            "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist.
+            "scoreSources": [ # List of all individual score sets.
+              { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores.
+                "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score.
+                "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.
+                "qaTagResults": [ # Collection of tags and their scores.
+                  { # Tags and their corresponding results.
+                    "normalizedScore": 3.14, # The normalized score the tag applies to.
+                    "potentialScore": 3.14, # The potential score the tag applies to.
+                    "score": 3.14, # The score the tag applies to.
+                    "tag": "A String", # The tag the score applies to.
+                  },
+                ],
+                "score": 3.14, # The overall numerical score of the result.
+                "sourceType": "A String", # What created the score.
+              },
+            ],
+          },
+        ],
+        "sentiments": [ # Overall conversation-level sentiment for each channel of the call.
+          { # One channel of conversation-level sentiment data.
+            "channelTag": 42, # The channel of the audio that the data applies to.
+            "sentimentData": { # The data for a sentiment annotation. # Data specifying sentiment.
+              "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+              "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+            },
+          },
+        ],
+        "silence": { # Conversation-level silence data. # Overall conversation-level silence during the call.
+          "silenceDuration": "A String", # Amount of time calculated to be in silence.
+          "silencePercentage": 3.14, # Percentage of the total conversation spent in silence.
+        },
+      },
+      "endTime": "A String", # The time at which the analysis ended.
+    },
+    "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
+      "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
+        "A String",
+      ],
+      "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
+        "A String",
+      ],
+      "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
+        "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
+          "qaScorecardRevisions": [ # List of QaScorecardRevisions.
+            "A String",
+          ],
+        },
+      },
+      "runEntityAnnotator": True or False, # Whether to run the entity annotator.
+      "runIntentAnnotator": True or False, # Whether to run the intent annotator.
+      "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
+      "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
+      "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
+      "runQaAnnotator": True or False, # Whether to run the QA annotator.
+      "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
+      "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
+      "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
+      "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
+        "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
+        "summarizationModel": "A String", # Default summarization model to be used.
+      },
+    },
+    "createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
+    "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
+    "requestTime": "A String", # Output only. The time at which the analysis was requested.
+  },
+  "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation.
+    "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+    "confidence": 3.14, # The confidence score of the summarization.
+    "conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
+    "metadata": { # A map that contains metadata about the summarization and the document from which it originates.
+      "a_key": "A String",
+    },
+    "text": "A String", # The summarization content that is concatenated into one string.
+    "textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
+      "a_key": "A String",
+    },
+  },
+  "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
+  "metadataJson": "A String", # Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.
+  "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
+  "obfuscatedUserId": "A String", # Obfuscated user ID which the customer sent to us.
+  "qualityMetadata": { # Conversation metadata related to quality management. # Conversation metadata related to quality management.
+    "agentInfo": [ # Information about agents involved in the call.
+      { # Information about an agent involved in the conversation.
+        "agentId": "A String", # A user-specified string representing the agent.
+        "displayName": "A String", # The agent's name.
+        "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
+        "team": "A String", # A user-specified string representing the agent's team.
+      },
+    ],
+    "customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating.
+    "menuPath": "A String", # An arbitrary string value specifying the menu path the customer took.
+    "waitDuration": "A String", # The amount of time the customer waited to connect with an agent.
+  },
+  "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction.
+    { # An annotation that was generated during the customer and agent interaction.
+      "annotationId": "A String", # The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}
+      "answerFeedback": { # The feedback that the customer has about a certain answer in the conversation. # The feedback that the customer has about the answer in `data`.
+        "clicked": True or False, # Indicates whether an answer or item was clicked by the human agent.
+        "correctnessLevel": "A String", # The correctness level of an answer.
+        "displayed": True or False, # Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.
+      },
+      "articleSuggestion": { # Agent Assist Article Suggestion data. # Agent Assist Article Suggestion data.
+        "confidenceScore": 3.14, # The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the Article Suggestion and the document that it originates from.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
+        "title": "A String", # Article title.
+        "uri": "A String", # Article URI.
+      },
+      "conversationSummarizationSuggestion": { # Conversation summarization suggestion data. # Conversation summarization suggestion data.
+        "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "confidence": 3.14, # The confidence score of the summarization.
+        "conversationModel": "A String", # The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
+        "metadata": { # A map that contains metadata about the summarization and the document from which it originates.
+          "a_key": "A String",
+        },
+        "text": "A String", # The summarization content that is concatenated into one string.
+        "textSections": { # The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
+          "a_key": "A String",
+        },
+      },
+      "createTime": "A String", # The time at which this annotation was created.
+      "dialogflowInteraction": { # Dialogflow interaction data. # Dialogflow interaction data.
+        "confidence": 3.14, # The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "dialogflowIntentId": "A String", # The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}
+      },
+      "endBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation ends, inclusive.
+        "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+        "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+      },
+      "faqAnswer": { # Agent Assist frequently-asked-question answer data. # Agent Assist FAQ answer data.
+        "answer": "A String", # The piece of text from the `source` knowledge base document.
+        "confidenceScore": 3.14, # The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the FAQ answer and the document that it originates from.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "question": "A String", # The corresponding FAQ question.
+        "source": "A String", # The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
+      },
+      "smartComposeSuggestion": { # Agent Assist Smart Compose suggestion data. # Agent Assist Smart Compose suggestion data.
+        "confidenceScore": 3.14, # The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the Smart Compose suggestion and the document from which it originates.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "suggestion": "A String", # The content of the suggestion.
+      },
+      "smartReply": { # Agent Assist Smart Reply data. # Agent Assist Smart Reply data.
+        "confidenceScore": 3.14, # The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
+        "metadata": { # Map that contains metadata about the Smart Reply and the document from which it originates.
+          "a_key": "A String",
+        },
+        "queryRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
+        "reply": "A String", # The content of the reply.
+      },
+      "startBoundary": { # A point in a conversation that marks the start or the end of an annotation. # The boundary in the conversation where the annotation starts, inclusive.
+        "transcriptIndex": 42, # The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
+        "wordIndex": 42, # The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
+      },
+      "userInput": { # Explicit input used for generating the answer # Explicit input used for generating the answer
+        "generatorName": "A String", # The resource name of associated generator. Format: `projects//locations//generators/`
+        "query": "A String", # Query text. Article Search uses this to store the input query used to generate the search results.
+        "querySource": "A String", # Query source for the answer.
+      },
+    },
+  ],
+  "startTime": "A String", # The time at which the conversation started.
+  "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript.
+    "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation.
+      { # A segment of a full transcript.
+        "channelTag": 42, # For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono.
+        "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.
+        "dialogflowSegmentMetadata": { # Metadata from Dialogflow relating to the current transcript segment. # CCAI metadata relating to the current transcript segment.
+          "smartReplyAllowlistCovered": True or False, # Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.
+        },
+        "languageCode": "A String", # The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US".
+        "messageTime": "A String", # The time that the message occurred, if provided.
+        "segmentParticipant": { # The call participant speaking for a given utterance. # The participant of this segment.
+          "dialogflowParticipant": "A String", # Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
+          "dialogflowParticipantName": "A String", # The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
+          "obfuscatedExternalUserId": "A String", # Obfuscated user ID from Dialogflow.
+          "role": "A String", # The role of the participant.
+          "userId": "A String", # A user-specified ID representing the participant.
+        },
+        "sentiment": { # The data for a sentiment annotation. # The sentiment for this transcript segment.
+          "magnitude": 3.14, # A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.
+          "score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive).
+        },
+        "text": "A String", # The text of this segment.
+        "words": [ # A list of the word-specific information for each word in the segment.
+          { # Word-level info for words in a transcript.
+            "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.
+            "endOffset": "A String", # Time offset of the end of this word relative to the beginning of the total conversation.
+            "startOffset": "A String", # Time offset of the start of this word relative to the beginning of the total conversation.
+            "word": "A String", # The word itself. Includes punctuation marks that surround the word.
+          },
+        ],
+      },
+    ],
+  },
+  "ttl": "A String", # Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.
+  "turnCount": 42, # Output only. The number of turns in the conversation.
+  "updateTime": "A String", # Output only. The most recent time at which the conversation was updated.
+}
+
+  conversationId: string, Optional. A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`
+  redactionConfig_deidentifyTemplate: string, The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`
+  redactionConfig_inspectTemplate: string, The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`
+  speechConfig_speechRecognizer: string, The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html new file mode 100644 index 0000000000..e39eb3f816 --- /dev/null +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html @@ -0,0 +1,268 @@ + + + +

Contact Center AI Insights API . projects . locations . authorizedViewSets . authorizedViews

+

Instance Methods

+

+ conversations() +

+

Returns the conversations Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

+

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

+

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

+

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

+

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

+

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

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.operations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.operations.html new file mode 100644 index 0000000000..e77ce58287 --- /dev/null +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.operations.html @@ -0,0 +1,208 @@ + + + +

Contact Center AI Insights API . projects . locations . authorizedViewSets . authorizedViews . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

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

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

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

+

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

+

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

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.html new file mode 100644 index 0000000000..ff33b09787 --- /dev/null +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.html @@ -0,0 +1,91 @@ + + + +

Contact Center AI Insights API . projects . locations . authorizedViewSets

+

Instance Methods

+

+ authorizedViews() +

+

Returns the authorizedViews Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html index b73c843793..07a7da98c0 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html @@ -191,6 +191,78 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, }, + "qaScorecardResults": [ # Results of scoring QaScorecards. + { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score. + "agentId": "A String", # ID of the agent that handled the conversation. + "conversation": "A String", # The conversation scored by this result. + "createTime": "A String", # Output only. The timestamp that the revision was created. + "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result} + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaAnswers": [ # Set of QaAnswers represented in the result. + { # An answer to a QaQuestion. + "answerSources": [ # List of all individual answers given to the question. + { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer. + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "sourceType": "A String", # What created the answer. + }, + ], + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "conversation": "A String", # The conversation the answer applies to. + "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead. + "qaQuestion": "A String", # The QaQuestion answered by this answer. + "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?" + "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer. + "A String", + ], + }, + ], + "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist. + "scoreSources": [ # List of all individual score sets. + { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores. + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result. + "sourceType": "A String", # What created the score. + }, + ], + }, + ], "sentiments": [ # Overall conversation-level sentiment for each channel of the call. { # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. @@ -214,11 +286,19 @@

Method Details

"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} "A String", ], + "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator. + "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score. + "qaScorecardRevisions": [ # List of QaScorecardRevisions. + "A String", + ], + }, + }, "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect. "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s). + "runQaAnnotator": True or False, # Whether to run the QA annotator. "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator. "runSilenceAnnotator": True or False, # Whether to run the silence annotator. "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator. @@ -377,6 +457,78 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, }, + "qaScorecardResults": [ # Results of scoring QaScorecards. + { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score. + "agentId": "A String", # ID of the agent that handled the conversation. + "conversation": "A String", # The conversation scored by this result. + "createTime": "A String", # Output only. The timestamp that the revision was created. + "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result} + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaAnswers": [ # Set of QaAnswers represented in the result. + { # An answer to a QaQuestion. + "answerSources": [ # List of all individual answers given to the question. + { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer. + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "sourceType": "A String", # What created the answer. + }, + ], + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "conversation": "A String", # The conversation the answer applies to. + "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead. + "qaQuestion": "A String", # The QaQuestion answered by this answer. + "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?" + "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer. + "A String", + ], + }, + ], + "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist. + "scoreSources": [ # List of all individual score sets. + { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores. + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result. + "sourceType": "A String", # What created the score. + }, + ], + }, + ], "sentiments": [ # Overall conversation-level sentiment for each channel of the call. { # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. @@ -400,11 +552,19 @@

Method Details

"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} "A String", ], + "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator. + "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score. + "qaScorecardRevisions": [ # List of QaScorecardRevisions. + "A String", + ], + }, + }, "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect. "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s). + "runQaAnnotator": True or False, # Whether to run the QA annotator. "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator. "runSilenceAnnotator": True or False, # Whether to run the silence annotator. "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator. @@ -522,6 +682,78 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, }, + "qaScorecardResults": [ # Results of scoring QaScorecards. + { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score. + "agentId": "A String", # ID of the agent that handled the conversation. + "conversation": "A String", # The conversation scored by this result. + "createTime": "A String", # Output only. The timestamp that the revision was created. + "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result} + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaAnswers": [ # Set of QaAnswers represented in the result. + { # An answer to a QaQuestion. + "answerSources": [ # List of all individual answers given to the question. + { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer. + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "sourceType": "A String", # What created the answer. + }, + ], + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "conversation": "A String", # The conversation the answer applies to. + "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead. + "qaQuestion": "A String", # The QaQuestion answered by this answer. + "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?" + "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer. + "A String", + ], + }, + ], + "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist. + "scoreSources": [ # List of all individual score sets. + { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores. + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result. + "sourceType": "A String", # What created the score. + }, + ], + }, + ], "sentiments": [ # Overall conversation-level sentiment for each channel of the call. { # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. @@ -545,11 +777,19 @@

Method Details

"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} "A String", ], + "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator. + "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score. + "qaScorecardRevisions": [ # List of QaScorecardRevisions. + "A String", + ], + }, + }, "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect. "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s). + "runQaAnnotator": True or False, # Whether to run the QA annotator. "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator. "runSilenceAnnotator": True or False, # Whether to run the silence annotator. "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.feedbackLabels.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.feedbackLabels.html new file mode 100644 index 0000000000..20be46d535 --- /dev/null +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.feedbackLabels.html @@ -0,0 +1,320 @@ + + + +

Contact Center AI Insights API . projects . locations . conversations . feedbackLabels

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Create feedback label.

+

+ delete(name, x__xgafv=None)

+

Delete feedback label.

+

+ get(name, x__xgafv=None)

+

Get feedback label.

+

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

+

List feedback labels.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update feedback label.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, feedbackLabelId=None, x__xgafv=None) +
Create feedback label.
+
+Args:
+  parent: string, Required. The parent resource of the feedback label. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a conversation, resource, and label provided by the user.
+  "createTime": "A String", # Output only. Create time of the label.
+  "label": "A String", # String label.
+  "labeledResource": "A String", # Resource name of the resource to be labeled.
+  "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
+  "qaAnswerLabel": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
+    "boolValue": True or False, # Boolean value.
+    "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+    "naValue": True or False, # A value of "Not Applicable (N/A)".
+    "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+    "numValue": 3.14, # Numerical value.
+    "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+    "score": 3.14, # Output only. Numerical score of the answer.
+    "strValue": "A String", # String value.
+  },
+  "updateTime": "A String", # Output only. Update time of the label.
+}
+
+  feedbackLabelId: string, Optional. The ID of the feedback label to create. If one is not specified it will be 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:
+
+    { # Represents a conversation, resource, and label provided by the user.
+  "createTime": "A String", # Output only. Create time of the label.
+  "label": "A String", # String label.
+  "labeledResource": "A String", # Resource name of the resource to be labeled.
+  "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
+  "qaAnswerLabel": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
+    "boolValue": True or False, # Boolean value.
+    "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+    "naValue": True or False, # A value of "Not Applicable (N/A)".
+    "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+    "numValue": 3.14, # Numerical value.
+    "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+    "score": 3.14, # Output only. Numerical score of the answer.
+    "strValue": "A String", # String value.
+  },
+  "updateTime": "A String", # Output only. Update time of the label.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Delete feedback label.
+
+Args:
+  name: string, Required. The name of the feedback label to delete. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Get feedback label.
+
+Args:
+  name: string, Required. The name of the feedback label to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a conversation, resource, and label provided by the user.
+  "createTime": "A String", # Output only. Create time of the label.
+  "label": "A String", # String label.
+  "labeledResource": "A String", # Resource name of the resource to be labeled.
+  "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
+  "qaAnswerLabel": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
+    "boolValue": True or False, # Boolean value.
+    "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+    "naValue": True or False, # A value of "Not Applicable (N/A)".
+    "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+    "numValue": 3.14, # Numerical value.
+    "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+    "score": 3.14, # Output only. Numerical score of the answer.
+    "strValue": "A String", # String value.
+  },
+  "updateTime": "A String", # Output only. Update time of the label.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
List feedback labels.
+
+Args:
+  parent: string, Required. The parent resource of the feedback labels. (required)
+  filter: string, Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
+  pageSize: integer, Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
+  pageToken: string, Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for listing feedback labels.
+  "feedbackLabels": [ # The feedback labels that match the request.
+    { # Represents a conversation, resource, and label provided by the user.
+      "createTime": "A String", # Output only. Create time of the label.
+      "label": "A String", # String label.
+      "labeledResource": "A String", # Resource name of the resource to be labeled.
+      "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
+      "qaAnswerLabel": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
+        "boolValue": True or False, # Boolean value.
+        "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+        "naValue": True or False, # A value of "Not Applicable (N/A)".
+        "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+        "numValue": 3.14, # Numerical value.
+        "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+        "score": 3.14, # Output only. Numerical score of the answer.
+        "strValue": "A String", # String value.
+      },
+      "updateTime": "A String", # Output only. Update time of the label.
+    },
+  ],
+  "nextPageToken": "A String", # The next page token.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Update feedback label.
+
+Args:
+  name: string, Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a conversation, resource, and label provided by the user.
+  "createTime": "A String", # Output only. Create time of the label.
+  "label": "A String", # String label.
+  "labeledResource": "A String", # Resource name of the resource to be labeled.
+  "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
+  "qaAnswerLabel": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
+    "boolValue": True or False, # Boolean value.
+    "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+    "naValue": True or False, # A value of "Not Applicable (N/A)".
+    "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+    "numValue": 3.14, # Numerical value.
+    "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+    "score": 3.14, # Output only. Numerical score of the answer.
+    "strValue": "A String", # String value.
+  },
+  "updateTime": "A String", # Output only. Update time of the label.
+}
+
+  updateMask: string, Required. The list of fields to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a conversation, resource, and label provided by the user.
+  "createTime": "A String", # Output only. Create time of the label.
+  "label": "A String", # String label.
+  "labeledResource": "A String", # Resource name of the resource to be labeled.
+  "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
+  "qaAnswerLabel": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
+    "boolValue": True or False, # Boolean value.
+    "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+    "naValue": True or False, # A value of "Not Applicable (N/A)".
+    "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+    "numValue": 3.14, # Numerical value.
+    "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+    "score": 3.14, # Output only. Numerical score of the answer.
+    "strValue": "A String", # String value.
+  },
+  "updateTime": "A String", # Output only. Update time of the label.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html index 3d23fbbaaf..0995663191 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html @@ -79,6 +79,11 @@

Instance Methods

Returns the analyses Resource.

+

+ feedbackLabels() +

+

Returns the feedbackLabels Resource.

+

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

Analyzes multiple conversations in a single request.

@@ -134,11 +139,19 @@

Method Details

"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} "A String", ], + "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator. + "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score. + "qaScorecardRevisions": [ # List of QaScorecardRevisions. + "A String", + ], + }, + }, "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect. "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s). + "runQaAnnotator": True or False, # Whether to run the QA annotator. "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator. "runSilenceAnnotator": True or False, # Whether to run the silence annotator. "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator. @@ -398,6 +411,78 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, }, + "qaScorecardResults": [ # Results of scoring QaScorecards. + { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score. + "agentId": "A String", # ID of the agent that handled the conversation. + "conversation": "A String", # The conversation scored by this result. + "createTime": "A String", # Output only. The timestamp that the revision was created. + "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result} + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaAnswers": [ # Set of QaAnswers represented in the result. + { # An answer to a QaQuestion. + "answerSources": [ # List of all individual answers given to the question. + { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer. + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "sourceType": "A String", # What created the answer. + }, + ], + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "conversation": "A String", # The conversation the answer applies to. + "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead. + "qaQuestion": "A String", # The QaQuestion answered by this answer. + "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?" + "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer. + "A String", + ], + }, + ], + "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist. + "scoreSources": [ # List of all individual score sets. + { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores. + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result. + "sourceType": "A String", # What created the score. + }, + ], + }, + ], "sentiments": [ # Overall conversation-level sentiment for each channel of the call. { # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. @@ -421,11 +506,19 @@

Method Details

"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} "A String", ], + "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator. + "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score. + "qaScorecardRevisions": [ # List of QaScorecardRevisions. + "A String", + ], + }, + }, "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect. "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s). + "runQaAnnotator": True or False, # Whether to run the QA annotator. "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator. "runSilenceAnnotator": True or False, # Whether to run the silence annotator. "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator. @@ -703,6 +796,78 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, }, + "qaScorecardResults": [ # Results of scoring QaScorecards. + { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score. + "agentId": "A String", # ID of the agent that handled the conversation. + "conversation": "A String", # The conversation scored by this result. + "createTime": "A String", # Output only. The timestamp that the revision was created. + "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result} + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaAnswers": [ # Set of QaAnswers represented in the result. + { # An answer to a QaQuestion. + "answerSources": [ # List of all individual answers given to the question. + { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer. + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "sourceType": "A String", # What created the answer. + }, + ], + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "conversation": "A String", # The conversation the answer applies to. + "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead. + "qaQuestion": "A String", # The QaQuestion answered by this answer. + "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?" + "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer. + "A String", + ], + }, + ], + "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist. + "scoreSources": [ # List of all individual score sets. + { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores. + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result. + "sourceType": "A String", # What created the score. + }, + ], + }, + ], "sentiments": [ # Overall conversation-level sentiment for each channel of the call. { # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. @@ -726,11 +891,19 @@

Method Details

"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} "A String", ], + "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator. + "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score. + "qaScorecardRevisions": [ # List of QaScorecardRevisions. + "A String", + ], + }, + }, "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect. "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s). + "runQaAnnotator": True or False, # Whether to run the QA annotator. "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator. "runSilenceAnnotator": True or False, # Whether to run the silence annotator. "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator. @@ -1038,6 +1211,78 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, }, + "qaScorecardResults": [ # Results of scoring QaScorecards. + { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score. + "agentId": "A String", # ID of the agent that handled the conversation. + "conversation": "A String", # The conversation scored by this result. + "createTime": "A String", # Output only. The timestamp that the revision was created. + "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result} + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaAnswers": [ # Set of QaAnswers represented in the result. + { # An answer to a QaQuestion. + "answerSources": [ # List of all individual answers given to the question. + { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer. + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "sourceType": "A String", # What created the answer. + }, + ], + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "conversation": "A String", # The conversation the answer applies to. + "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead. + "qaQuestion": "A String", # The QaQuestion answered by this answer. + "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?" + "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer. + "A String", + ], + }, + ], + "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist. + "scoreSources": [ # List of all individual score sets. + { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores. + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result. + "sourceType": "A String", # What created the score. + }, + ], + }, + ], "sentiments": [ # Overall conversation-level sentiment for each channel of the call. { # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. @@ -1061,11 +1306,19 @@

Method Details

"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} "A String", ], + "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator. + "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score. + "qaScorecardRevisions": [ # List of QaScorecardRevisions. + "A String", + ], + }, + }, "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect. "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s). + "runQaAnnotator": True or False, # Whether to run the QA annotator. "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator. "runSilenceAnnotator": True or False, # Whether to run the silence annotator. "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator. @@ -1426,6 +1679,78 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, }, + "qaScorecardResults": [ # Results of scoring QaScorecards. + { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score. + "agentId": "A String", # ID of the agent that handled the conversation. + "conversation": "A String", # The conversation scored by this result. + "createTime": "A String", # Output only. The timestamp that the revision was created. + "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result} + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaAnswers": [ # Set of QaAnswers represented in the result. + { # An answer to a QaQuestion. + "answerSources": [ # List of all individual answers given to the question. + { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer. + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "sourceType": "A String", # What created the answer. + }, + ], + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "conversation": "A String", # The conversation the answer applies to. + "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead. + "qaQuestion": "A String", # The QaQuestion answered by this answer. + "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?" + "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer. + "A String", + ], + }, + ], + "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist. + "scoreSources": [ # List of all individual score sets. + { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores. + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result. + "sourceType": "A String", # What created the score. + }, + ], + }, + ], "sentiments": [ # Overall conversation-level sentiment for each channel of the call. { # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. @@ -1449,11 +1774,19 @@

Method Details

"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} "A String", ], + "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator. + "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score. + "qaScorecardRevisions": [ # List of QaScorecardRevisions. + "A String", + ], + }, + }, "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect. "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s). + "runQaAnnotator": True or False, # Whether to run the QA annotator. "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator. "runSilenceAnnotator": True or False, # Whether to run the silence annotator. "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator. @@ -1749,6 +2082,78 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, }, + "qaScorecardResults": [ # Results of scoring QaScorecards. + { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score. + "agentId": "A String", # ID of the agent that handled the conversation. + "conversation": "A String", # The conversation scored by this result. + "createTime": "A String", # Output only. The timestamp that the revision was created. + "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result} + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaAnswers": [ # Set of QaAnswers represented in the result. + { # An answer to a QaQuestion. + "answerSources": [ # List of all individual answers given to the question. + { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer. + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "sourceType": "A String", # What created the answer. + }, + ], + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "conversation": "A String", # The conversation the answer applies to. + "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead. + "qaQuestion": "A String", # The QaQuestion answered by this answer. + "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?" + "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer. + "A String", + ], + }, + ], + "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist. + "scoreSources": [ # List of all individual score sets. + { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores. + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result. + "sourceType": "A String", # What created the score. + }, + ], + }, + ], "sentiments": [ # Overall conversation-level sentiment for each channel of the call. { # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. @@ -1772,11 +2177,19 @@

Method Details

"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} "A String", ], + "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator. + "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score. + "qaScorecardRevisions": [ # List of QaScorecardRevisions. + "A String", + ], + }, + }, "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect. "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s). + "runQaAnnotator": True or False, # Whether to run the QA annotator. "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator. "runSilenceAnnotator": True or False, # Whether to run the silence annotator. "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator. @@ -2054,6 +2467,78 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, }, + "qaScorecardResults": [ # Results of scoring QaScorecards. + { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score. + "agentId": "A String", # ID of the agent that handled the conversation. + "conversation": "A String", # The conversation scored by this result. + "createTime": "A String", # Output only. The timestamp that the revision was created. + "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result} + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaAnswers": [ # Set of QaAnswers represented in the result. + { # An answer to a QaQuestion. + "answerSources": [ # List of all individual answers given to the question. + { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer. + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "sourceType": "A String", # What created the answer. + }, + ], + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "conversation": "A String", # The conversation the answer applies to. + "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead. + "qaQuestion": "A String", # The QaQuestion answered by this answer. + "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?" + "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer. + "A String", + ], + }, + ], + "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist. + "scoreSources": [ # List of all individual score sets. + { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores. + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result. + "sourceType": "A String", # What created the score. + }, + ], + }, + ], "sentiments": [ # Overall conversation-level sentiment for each channel of the call. { # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. @@ -2077,11 +2562,19 @@

Method Details

"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} "A String", ], + "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator. + "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score. + "qaScorecardRevisions": [ # List of QaScorecardRevisions. + "A String", + ], + }, + }, "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect. "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s). + "runQaAnnotator": True or False, # Whether to run the QA annotator. "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator. "runSilenceAnnotator": True or False, # Whether to run the silence annotator. "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator. @@ -2361,6 +2854,78 @@

Method Details

"phraseMatcher": "A String", # The unique identifier (the resource name) of the phrase matcher. }, }, + "qaScorecardResults": [ # Results of scoring QaScorecards. + { # The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score. + "agentId": "A String", # ID of the agent that handled the conversation. + "conversation": "A String", # The conversation scored by this result. + "createTime": "A String", # Output only. The timestamp that the revision was created. + "name": "A String", # Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result} + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaAnswers": [ # Set of QaAnswers represented in the result. + { # An answer to a QaQuestion. + "answerSources": [ # List of all individual answers given to the question. + { # A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer. + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The answer value from this source. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "sourceType": "A String", # What created the answer. + }, + ], + "answerValue": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # The main answer value, incorporating any manual edits if they exist. + "boolValue": True or False, # Boolean value. + "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. + "naValue": True or False, # A value of "Not Applicable (N/A)". + "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0 + "numValue": 3.14, # Numerical value. + "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "score": 3.14, # Output only. Numerical score of the answer. + "strValue": "A String", # String value. + }, + "conversation": "A String", # The conversation the answer applies to. + "potentialScore": 3.14, # The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead. + "qaQuestion": "A String", # The QaQuestion answered by this answer. + "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?" + "tags": [ # User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer. + "A String", + ], + }, + ], + "qaScorecardRevision": "A String", # The QaScorecardRevision scored by this result. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result, incorporating any manual edits if they exist. + "scoreSources": [ # List of all individual score sets. + { # A scorecard result may have multiple sets of scores from varying sources, one of which becomes the "main" answer above. A ScoreSource represents each individual set of scores. + "normalizedScore": 3.14, # The normalized score, which is the score divided by the potential score. + "potentialScore": 3.14, # The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. + "qaTagResults": [ # Collection of tags and their scores. + { # Tags and their corresponding results. + "normalizedScore": 3.14, # The normalized score the tag applies to. + "potentialScore": 3.14, # The potential score the tag applies to. + "score": 3.14, # The score the tag applies to. + "tag": "A String", # The tag the score applies to. + }, + ], + "score": 3.14, # The overall numerical score of the result. + "sourceType": "A String", # What created the score. + }, + ], + }, + ], "sentiments": [ # Overall conversation-level sentiment for each channel of the call. { # One channel of conversation-level sentiment data. "channelTag": 42, # The channel of the audio that the data applies to. @@ -2384,11 +2949,19 @@

Method Details

"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} "A String", ], + "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator. + "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score. + "qaScorecardRevisions": [ # List of QaScorecardRevisions. + "A String", + ], + }, + }, "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect. "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s). + "runQaAnnotator": True or False, # Whether to run the QA annotator. "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator. "runSilenceAnnotator": True or False, # Whether to run the silence annotator. "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.html index fcf8b62acb..3240792d3b 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.html @@ -74,6 +74,21 @@

Contact Center AI Insights API . projects . locations

Instance Methods

+

+ analysisRules() +

+

Returns the analysisRules Resource.

+ +

+ authorizedViewSet() +

+

Returns the authorizedViewSet Resource.

+ +

+ authorizedViewSets() +

+

Returns the authorizedViewSets Resource.

+

conversations()

@@ -104,11 +119,22 @@

Instance Methods

Returns the phraseMatchers Resource.

+

+ qaScorecards() +

+

Returns the qaScorecards Resource.

+

views()

Returns the views Resource.

+

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

+

Download feedback labels in bulk.

+

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

+

Upload feedback labels in bulk.

close()

Close httplib2 connections.

@@ -118,10 +144,121 @@

Instance Methods

getSettings(name, x__xgafv=None)

Gets project-level settings.

+

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

+

List all feedback labels by project number.

+

+ listAllFeedbackLabels_next()

+

Retrieves the next page of results.

+

+ queryMetrics(location, body=None, x__xgafv=None)

+

Query metrics.

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

Updates project-level settings.

Method Details

+
+ bulkDownloadFeedbackLabels(parent, body=None, x__xgafv=None) +
Download feedback labels in bulk.
+
+Args:
+  parent: string, Required. The parent resource for new feedback labels. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for the BulkDownloadFeedbackLabel endpoint.
+  "conversationFilter": "A String", # Optional. Filter parent conversations to download feedback labels for. When specified, the feedback labels will be downloaded for the conversations that match the filter. If `template_qa_scorecard_id` is set, all the conversations that match the filter will be paired with the questions under the scorecard for labeling.
+  "feedbackLabelType": "A String", # Optional. The type of feedback labels that will be downloaded.
+  "filter": "A String", # Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
+  "gcsDestination": { # Google Cloud Storage Object details to write the feedback labels to. # A cloud storage bucket destination.
+    "addWhitespace": True or False, # Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format.
+    "alwaysPrintEmptyFields": True or False, # Optional. Always print fields with no presence. This is useful for printing fields that are not set, like implicit 0 value or empty lists/maps. Only applicable for JSON format.
+    "format": "A String", # Required. File format in which the labels will be exported.
+    "objectUri": "A String", # Required. The Google Cloud Storage URI to write the feedback labels to. The file name will be used as a prefix for the files written to the bucket if the output needs to be split across multiple files, otherwise it will be used as is. The file extension will be appended to the file name based on the format selected. E.g. `gs://bucket_name/object_uri_prefix`
+    "recordsPerFileCount": "A String", # Optional. The number of records per file. Applicable for either format.
+  },
+  "maxDownloadCount": 42, # Optional. Limits the maximum number of feedback labels that will be downloaded. The first `N` feedback labels will be downloaded.
+  "parent": "A String", # Required. The parent resource for new feedback labels.
+  "templateQaScorecardId": [ # Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversation_filter and the questions under the scorecard(s). The feedback label `filter` will be ignored.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ bulkUploadFeedbackLabels(parent, body=None, x__xgafv=None) +
Upload feedback labels in bulk.
+
+Args:
+  parent: string, Required. The parent resource for new feedback labels. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request for bulk uploading feedback labels.
+  "gcsSource": { # Google Cloud Storage Object details to get the feedback label file from. # A cloud storage bucket source.
+    "format": "A String", # Required. File format which will be ingested.
+    "objectUri": "A String", # Required. The Google Cloud Storage URI of the file to import. Format: `gs://bucket_name/object_name`
+  },
+  "validateOnly": True or False, # Optional. If set, upload will not happen and the labels will be validated. If not set, then default behavior will be to upload the labels after validation is complete.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
close()
Close httplib2 connections.
@@ -170,11 +307,19 @@

Method Details

"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} "A String", ], + "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator. + "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score. + "qaScorecardRevisions": [ # List of QaScorecardRevisions. + "A String", + ], + }, + }, "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect. "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s). + "runQaAnnotator": True or False, # Whether to run the QA annotator. "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator. "runSilenceAnnotator": True or False, # Whether to run the silence annotator. "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator. @@ -204,6 +349,131 @@

Method Details

}
+
+ listAllFeedbackLabels(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
List all feedback labels by project number.
+
+Args:
+  parent: string, Required. The parent resource of all feedback labels per project. (required)
+  filter: string, Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
+  pageSize: integer, Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
+  pageToken: string, Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for listing all feedback labels.
+  "feedbackLabels": [ # The feedback labels that match the request.
+    { # Represents a conversation, resource, and label provided by the user.
+      "createTime": "A String", # Output only. Create time of the label.
+      "label": "A String", # String label.
+      "labeledResource": "A String", # Resource name of the resource to be labeled.
+      "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
+      "qaAnswerLabel": { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
+        "boolValue": True or False, # Boolean value.
+        "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
+        "naValue": True or False, # A value of "Not Applicable (N/A)".
+        "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
+        "numValue": 3.14, # Numerical value.
+        "potentialScore": 3.14, # Output only. The maximum potential score of the question.
+        "score": 3.14, # Output only. Numerical score of the answer.
+        "strValue": "A String", # String value.
+      },
+      "updateTime": "A String", # Output only. Update time of the label.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ listAllFeedbackLabels_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.
+        
+
+ +
+ queryMetrics(location, body=None, x__xgafv=None) +
Query metrics.
+
+Args:
+  location: string, Required. The location of the data. "projects/{project}/locations/{location}" (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request for querying metrics.
+  "dimensions": [ # The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension's key must be unique. If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity. Up to one dimension is supported for now.
+    { # A dimension determines the grouping key for the query. In SQL terms, these would be part of both the "SELECT" and "GROUP BY" clauses.
+      "agentDimensionMetadata": { # Metadata about the agent dimension. # Output only. Metadata about the agent dimension.
+        "agentDisplayName": "A String", # Optional. The agent's name
+        "agentId": "A String", # Optional. A user-specified string representing the agent.
+        "agentTeam": "A String", # Optional. A user-specified string representing the agent's team.
+      },
+      "dimensionKey": "A String", # The key of the dimension.
+      "issueDimensionMetadata": { # Metadata about the issue dimension. # Output only. Metadata about the issue dimension.
+        "issueDisplayName": "A String", # The issue display name.
+        "issueId": "A String", # The issue ID.
+        "issueModelId": "A String", # The parent issue model ID.
+      },
+      "qaQuestionAnswerDimensionMetadata": { # Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard. # Output only. Metadata about the QA question-answer dimension.
+        "answerValue": "A String", # Optional. The full body of the question.
+        "qaQuestionId": "A String", # Optional. The QA question ID.
+        "qaScorecardId": "A String", # Optional. The QA scorecard ID.
+        "questionBody": "A String", # Optional. The full body of the question.
+      },
+      "qaQuestionDimensionMetadata": { # Metadata about the QA question dimension. # Output only. Metadata about the QA question dimension.
+        "qaQuestionId": "A String", # Optional. The QA question ID.
+        "qaScorecardId": "A String", # Optional. The QA scorecard ID.
+        "questionBody": "A String", # Optional. The full body of the question.
+      },
+    },
+  ],
+  "filter": "A String", # Required. Filter to select a subset of conversations to compute the metrics. Must specify a window of the conversation create time to compute the metrics. The returned metrics will be from the range [DATE(starting create time), DATE(ending create time)).
+  "measureMask": "A String", # Measures to return. Defaults to all measures if this field is unspecified. A valid mask should traverse from the `measure` field from the response. For example, a path from a measure mask to get the conversation count is "conversation_measure.count".
+  "timeGranularity": "A String", # The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
updateSettings(name, body=None, updateMask=None, x__xgafv=None)
Updates project-level settings.
@@ -222,11 +492,19 @@ 

Method Details

"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} "A String", ], + "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator. + "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score. + "qaScorecardRevisions": [ # List of QaScorecardRevisions. + "A String", + ], + }, + }, "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect. "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s). + "runQaAnnotator": True or False, # Whether to run the QA annotator. "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator. "runSilenceAnnotator": True or False, # Whether to run the silence annotator. "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator. @@ -273,11 +551,19 @@

Method Details

"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} "A String", ], + "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator. + "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score. + "qaScorecardRevisions": [ # List of QaScorecardRevisions. + "A String", + ], + }, + }, "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect. "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s). + "runQaAnnotator": True or False, # Whether to run the QA annotator. "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator. "runSilenceAnnotator": True or False, # Whether to run the silence annotator. "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.html b/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.html new file mode 100644 index 0000000000..24de26a5cf --- /dev/null +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.html @@ -0,0 +1,265 @@ + + + +

Contact Center AI Insights API . projects . locations . qaScorecards

+

Instance Methods

+

+ revisions() +

+

Returns the revisions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Create a QaScorecard.

+

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

+

Deletes a QaScorecard.

+

+ get(name, x__xgafv=None)

+

Gets a QaScorecard.

+

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

+

Lists QaScorecards.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a QaScorecard.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, qaScorecardId=None, x__xgafv=None) +
Create a QaScorecard.
+
+Args:
+  parent: string, Required. The parent resource of the QaScorecard. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A QaScorecard represents a collection of questions to be scored during analysis.
+  "createTime": "A String", # Output only. The time at which this scorecard was created.
+  "description": "A String", # A text description explaining the intent of the scorecard.
+  "displayName": "A String", # The user-specified display name of the scorecard.
+  "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
+  "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
+}
+
+  qaScorecardId: string, Optional. A unique ID for the new QaScorecard. This ID will become the final component of the QaScorecard's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A QaScorecard represents a collection of questions to be scored during analysis.
+  "createTime": "A String", # Output only. The time at which this scorecard was created.
+  "description": "A String", # A text description explaining the intent of the scorecard.
+  "displayName": "A String", # The user-specified display name of the scorecard.
+  "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
+  "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
+}
+
+ +
+ delete(name, force=None, x__xgafv=None) +
Deletes a QaScorecard.
+
+Args:
+  name: string, Required. The name of the QaScorecard to delete. (required)
+  force: boolean, Optional. If set to true, all of this QaScorecard's child resources will also be deleted. Otherwise, the request will only succeed if it has none.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a QaScorecard.
+
+Args:
+  name: string, Required. The name of the QaScorecard to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A QaScorecard represents a collection of questions to be scored during analysis.
+  "createTime": "A String", # Output only. The time at which this scorecard was created.
+  "description": "A String", # A text description explaining the intent of the scorecard.
+  "displayName": "A String", # The user-specified display name of the scorecard.
+  "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
+  "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists QaScorecards.
+
+Args:
+  parent: string, Required. The parent resource of the scorecards. (required)
+  pageSize: integer, Optional. The maximum number of scorecards to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
+  pageToken: string, Optional. The value returned by the last `ListQaScorecardsResponse`. This value indicates that this is a continuation of a prior `ListQaScorecards` call and that the system should return the next page of data.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response from a ListQaScorecards request.
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "qaScorecards": [ # The QaScorecards under the parent.
+    { # A QaScorecard represents a collection of questions to be scored during analysis.
+      "createTime": "A String", # Output only. The time at which this scorecard was created.
+      "description": "A String", # A text description explaining the intent of the scorecard.
+      "displayName": "A String", # The user-specified display name of the scorecard.
+      "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
+      "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a QaScorecard.
+
+Args:
+  name: string, Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A QaScorecard represents a collection of questions to be scored during analysis.
+  "createTime": "A String", # Output only. The time at which this scorecard was created.
+  "description": "A String", # A text description explaining the intent of the scorecard.
+  "displayName": "A String", # The user-specified display name of the scorecard.
+  "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
+  "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
+}
+
+  updateMask: string, Required. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `description` * `display_name`
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A QaScorecard represents a collection of questions to be scored during analysis.
+  "createTime": "A String", # Output only. The time at which this scorecard was created.
+  "description": "A String", # A text description explaining the intent of the scorecard.
+  "displayName": "A String", # The user-specified display name of the scorecard.
+  "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
+  "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.revisions.html b/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.revisions.html new file mode 100644 index 0000000000..983273b0c8 --- /dev/null +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.revisions.html @@ -0,0 +1,386 @@ + + + +

Contact Center AI Insights API . projects . locations . qaScorecards . revisions

+

Instance Methods

+

+ qaQuestions() +

+

Returns the qaQuestions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a QaScorecardRevision.

+

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

+

Deletes a QaScorecardRevision.

+

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

+

Deploy a QaScorecardRevision.

+

+ get(name, x__xgafv=None)

+

Gets a QaScorecardRevision.

+

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

+

Lists all revisions under the parent QaScorecard.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Fine tune one or more QaModels.

+

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

+

Undeploy a QaScorecardRevision.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, qaScorecardRevisionId=None, x__xgafv=None) +
Creates a QaScorecardRevision.
+
+Args:
+  parent: string, Required. The parent resource of the QaScorecardRevision. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A revision of a QaScorecard. Modifying published scorecard fields would invalidate existing scorecard results — the questions may have changed, or the score weighting will make existing scores impossible to understand. So changes must create a new revision, rather than modifying the existing resource.
+  "alternateIds": [ # Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. The timestamp that the revision was created.
+  "name": "A String", # Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}
+  "snapshot": { # A QaScorecard represents a collection of questions to be scored during analysis. # The snapshot of the scorecard at the time of this revision's creation.
+    "createTime": "A String", # Output only. The time at which this scorecard was created.
+    "description": "A String", # A text description explaining the intent of the scorecard.
+    "displayName": "A String", # The user-specified display name of the scorecard.
+    "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
+    "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
+  },
+  "state": "A String", # Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis.
+}
+
+  qaScorecardRevisionId: string, Optional. A unique ID for the new QaScorecardRevision. This ID will become the final component of the QaScorecardRevision's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A revision of a QaScorecard. Modifying published scorecard fields would invalidate existing scorecard results — the questions may have changed, or the score weighting will make existing scores impossible to understand. So changes must create a new revision, rather than modifying the existing resource.
+  "alternateIds": [ # Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. The timestamp that the revision was created.
+  "name": "A String", # Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}
+  "snapshot": { # A QaScorecard represents a collection of questions to be scored during analysis. # The snapshot of the scorecard at the time of this revision's creation.
+    "createTime": "A String", # Output only. The time at which this scorecard was created.
+    "description": "A String", # A text description explaining the intent of the scorecard.
+    "displayName": "A String", # The user-specified display name of the scorecard.
+    "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
+    "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
+  },
+  "state": "A String", # Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis.
+}
+
+ +
+ delete(name, force=None, x__xgafv=None) +
Deletes a QaScorecardRevision.
+
+Args:
+  name: string, Required. The name of the QaScorecardRevision to delete. (required)
+  force: boolean, Optional. If set to true, all of this QaScorecardRevision's child resources will also be deleted. Otherwise, the request will only succeed if it has none.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ deploy(name, body=None, x__xgafv=None) +
Deploy a QaScorecardRevision.
+
+Args:
+  name: string, Required. The name of the QaScorecardRevision to deploy. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request to deploy a QaScorecardRevision
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A revision of a QaScorecard. Modifying published scorecard fields would invalidate existing scorecard results — the questions may have changed, or the score weighting will make existing scores impossible to understand. So changes must create a new revision, rather than modifying the existing resource.
+  "alternateIds": [ # Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. The timestamp that the revision was created.
+  "name": "A String", # Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}
+  "snapshot": { # A QaScorecard represents a collection of questions to be scored during analysis. # The snapshot of the scorecard at the time of this revision's creation.
+    "createTime": "A String", # Output only. The time at which this scorecard was created.
+    "description": "A String", # A text description explaining the intent of the scorecard.
+    "displayName": "A String", # The user-specified display name of the scorecard.
+    "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
+    "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
+  },
+  "state": "A String", # Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis.
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a QaScorecardRevision.
+
+Args:
+  name: string, Required. The name of the QaScorecardRevision to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A revision of a QaScorecard. Modifying published scorecard fields would invalidate existing scorecard results — the questions may have changed, or the score weighting will make existing scores impossible to understand. So changes must create a new revision, rather than modifying the existing resource.
+  "alternateIds": [ # Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. The timestamp that the revision was created.
+  "name": "A String", # Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}
+  "snapshot": { # A QaScorecard represents a collection of questions to be scored during analysis. # The snapshot of the scorecard at the time of this revision's creation.
+    "createTime": "A String", # Output only. The time at which this scorecard was created.
+    "description": "A String", # A text description explaining the intent of the scorecard.
+    "displayName": "A String", # The user-specified display name of the scorecard.
+    "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
+    "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
+  },
+  "state": "A String", # Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all revisions under the parent QaScorecard.
+
+Args:
+  parent: string, Required. The parent resource of the scorecard revisions. To list all revisions of all scorecards, substitute the QaScorecard ID with a '-' character. (required)
+  filter: string, Optional. A filter to reduce results to a specific subset. Useful for querying scorecard revisions with specific properties.
+  pageSize: integer, Optional. The maximum number of scorecard revisions to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
+  pageToken: string, Optional. The value returned by the last `ListQaScorecardRevisionsResponse`. This value indicates that this is a continuation of a prior `ListQaScorecardRevisions` call and that the system should return the next page of data.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response from a ListQaScorecardRevisions request.
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "qaScorecardRevisions": [ # The QaScorecards under the parent.
+    { # A revision of a QaScorecard. Modifying published scorecard fields would invalidate existing scorecard results — the questions may have changed, or the score weighting will make existing scores impossible to understand. So changes must create a new revision, rather than modifying the existing resource.
+      "alternateIds": [ # Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.
+        "A String",
+      ],
+      "createTime": "A String", # Output only. The timestamp that the revision was created.
+      "name": "A String", # Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}
+      "snapshot": { # A QaScorecard represents a collection of questions to be scored during analysis. # The snapshot of the scorecard at the time of this revision's creation.
+        "createTime": "A String", # Output only. The time at which this scorecard was created.
+        "description": "A String", # A text description explaining the intent of the scorecard.
+        "displayName": "A String", # The user-specified display name of the scorecard.
+        "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
+        "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
+      },
+      "state": "A String", # Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis.
+    },
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ tuneQaScorecardRevision(parent, body=None, x__xgafv=None) +
Fine tune one or more QaModels.
+
+Args:
+  parent: string, Required. The parent resource for new fine tuning job instance. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for TuneQaScorecardRevision endpoint.
+  "filter": "A String", # Required. Filter for selecting the feedback labels that needs to be used for training. This filter can be used to limit the feedback labels used for tuning to a feedback labels created or updated for a specific time-window etc.
+  "validateOnly": True or False, # Optional. Run in validate only mode, no fine tuning will actually run. Data quality validations like training data distributions will run. Even when set to false, the data quality validations will still run but once the validations complete we will proceed with the fine tune, if applicable.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ undeploy(name, body=None, x__xgafv=None) +
Undeploy a QaScorecardRevision.
+
+Args:
+  name: string, Required. The name of the QaScorecardRevision to undeploy. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request to undeploy a QaScorecardRevision
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A revision of a QaScorecard. Modifying published scorecard fields would invalidate existing scorecard results — the questions may have changed, or the score weighting will make existing scores impossible to understand. So changes must create a new revision, rather than modifying the existing resource.
+  "alternateIds": [ # Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. The timestamp that the revision was created.
+  "name": "A String", # Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}
+  "snapshot": { # A QaScorecard represents a collection of questions to be scored during analysis. # The snapshot of the scorecard at the time of this revision's creation.
+    "createTime": "A String", # Output only. The time at which this scorecard was created.
+    "description": "A String", # A text description explaining the intent of the scorecard.
+    "displayName": "A String", # The user-specified display name of the scorecard.
+    "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
+    "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
+  },
+  "state": "A String", # Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.revisions.qaQuestions.html b/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.revisions.qaQuestions.html new file mode 100644 index 0000000000..ded0d9208c --- /dev/null +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.revisions.qaQuestions.html @@ -0,0 +1,409 @@ + + + +

Contact Center AI Insights API . projects . locations . qaScorecards . revisions . qaQuestions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Create a QaQuestion.

+

+ delete(name, x__xgafv=None)

+

Deletes a QaQuestion.

+

+ get(name, x__xgafv=None)

+

Gets a QaQuestion.

+

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

+

Lists QaQuestions.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a QaQuestion.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, qaQuestionId=None, x__xgafv=None) +
Create a QaQuestion.
+
+Args:
+  parent: string, Required. The parent resource of the QaQuestion. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single question to be scored by the Insights QA feature.
+  "abbreviation": "A String", # Short, descriptive string, used in the UI where it's not practical to display the full question body. E.g., "Greeting".
+  "answerChoices": [ # A list of valid answers to the question, which the LLM must choose from.
+    { # Message representing a possible answer to the question.
+      "boolValue": True or False, # Boolean value.
+      "key": "A String", # A short string used as an identifier.
+      "naValue": True or False, # A value of "Not Applicable (N/A)". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations.
+      "numValue": 3.14, # Numerical value.
+      "score": 3.14, # Numerical score of the answer, used for generating the overall score of a QaScorecardResult. If the answer uses na_value, this field is unused.
+      "strValue": "A String", # String value.
+    },
+  ],
+  "answerInstructions": "A String", # Instructions describing how to determine the answer.
+  "createTime": "A String", # Output only. The time at which this question was created.
+  "metrics": { # A wrapper representing metrics calculated against a test-set on a LLM that was fine tuned for this question. # Metrics of the underlying tuned LLM over a holdout/test set while fine tuning the underlying LLM for the given question. This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.
+    "accuracy": 3.14, # Output only. Accuracy of the model. Measures the percentage of correct answers the model gave on the test set.
+  },
+  "name": "A String", # Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}
+  "order": 42, # Defines the order of the question within its parent scorecard revision.
+  "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
+  "tags": [ # User-defined list of arbitrary tags for the question. Used for grouping/organization and for weighting the score of each question.
+    "A String",
+  ],
+  "tuningMetadata": { # Metadata about the tuning operation for the question. Will only be set if a scorecard containing this question has been tuned. # Metadata about the tuning operation for the question.This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.
+    "datasetValidationWarnings": [ # A list of any applicable data validation warnings about the question's feedback labels.
+      "A String",
+    ],
+    "totalValidLabelCount": "A String", # Total number of valid labels provided for the question at the time of tuining.
+    "tuningError": "A String", # Error status of the tuning operation for the question. Will only be set if the tuning operation failed.
+  },
+  "updateTime": "A String", # Output only. The most recent time at which the question was updated.
+}
+
+  qaQuestionId: string, Optional. A unique ID for the new question. This ID will become the final component of the question's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single question to be scored by the Insights QA feature.
+  "abbreviation": "A String", # Short, descriptive string, used in the UI where it's not practical to display the full question body. E.g., "Greeting".
+  "answerChoices": [ # A list of valid answers to the question, which the LLM must choose from.
+    { # Message representing a possible answer to the question.
+      "boolValue": True or False, # Boolean value.
+      "key": "A String", # A short string used as an identifier.
+      "naValue": True or False, # A value of "Not Applicable (N/A)". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations.
+      "numValue": 3.14, # Numerical value.
+      "score": 3.14, # Numerical score of the answer, used for generating the overall score of a QaScorecardResult. If the answer uses na_value, this field is unused.
+      "strValue": "A String", # String value.
+    },
+  ],
+  "answerInstructions": "A String", # Instructions describing how to determine the answer.
+  "createTime": "A String", # Output only. The time at which this question was created.
+  "metrics": { # A wrapper representing metrics calculated against a test-set on a LLM that was fine tuned for this question. # Metrics of the underlying tuned LLM over a holdout/test set while fine tuning the underlying LLM for the given question. This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.
+    "accuracy": 3.14, # Output only. Accuracy of the model. Measures the percentage of correct answers the model gave on the test set.
+  },
+  "name": "A String", # Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}
+  "order": 42, # Defines the order of the question within its parent scorecard revision.
+  "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
+  "tags": [ # User-defined list of arbitrary tags for the question. Used for grouping/organization and for weighting the score of each question.
+    "A String",
+  ],
+  "tuningMetadata": { # Metadata about the tuning operation for the question. Will only be set if a scorecard containing this question has been tuned. # Metadata about the tuning operation for the question.This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.
+    "datasetValidationWarnings": [ # A list of any applicable data validation warnings about the question's feedback labels.
+      "A String",
+    ],
+    "totalValidLabelCount": "A String", # Total number of valid labels provided for the question at the time of tuining.
+    "tuningError": "A String", # Error status of the tuning operation for the question. Will only be set if the tuning operation failed.
+  },
+  "updateTime": "A String", # Output only. The most recent time at which the question was updated.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a QaQuestion.
+
+Args:
+  name: string, Required. The name of the QaQuestion to delete. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a QaQuestion.
+
+Args:
+  name: string, Required. The name of the QaQuestion to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single question to be scored by the Insights QA feature.
+  "abbreviation": "A String", # Short, descriptive string, used in the UI where it's not practical to display the full question body. E.g., "Greeting".
+  "answerChoices": [ # A list of valid answers to the question, which the LLM must choose from.
+    { # Message representing a possible answer to the question.
+      "boolValue": True or False, # Boolean value.
+      "key": "A String", # A short string used as an identifier.
+      "naValue": True or False, # A value of "Not Applicable (N/A)". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations.
+      "numValue": 3.14, # Numerical value.
+      "score": 3.14, # Numerical score of the answer, used for generating the overall score of a QaScorecardResult. If the answer uses na_value, this field is unused.
+      "strValue": "A String", # String value.
+    },
+  ],
+  "answerInstructions": "A String", # Instructions describing how to determine the answer.
+  "createTime": "A String", # Output only. The time at which this question was created.
+  "metrics": { # A wrapper representing metrics calculated against a test-set on a LLM that was fine tuned for this question. # Metrics of the underlying tuned LLM over a holdout/test set while fine tuning the underlying LLM for the given question. This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.
+    "accuracy": 3.14, # Output only. Accuracy of the model. Measures the percentage of correct answers the model gave on the test set.
+  },
+  "name": "A String", # Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}
+  "order": 42, # Defines the order of the question within its parent scorecard revision.
+  "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
+  "tags": [ # User-defined list of arbitrary tags for the question. Used for grouping/organization and for weighting the score of each question.
+    "A String",
+  ],
+  "tuningMetadata": { # Metadata about the tuning operation for the question. Will only be set if a scorecard containing this question has been tuned. # Metadata about the tuning operation for the question.This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.
+    "datasetValidationWarnings": [ # A list of any applicable data validation warnings about the question's feedback labels.
+      "A String",
+    ],
+    "totalValidLabelCount": "A String", # Total number of valid labels provided for the question at the time of tuining.
+    "tuningError": "A String", # Error status of the tuning operation for the question. Will only be set if the tuning operation failed.
+  },
+  "updateTime": "A String", # Output only. The most recent time at which the question was updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists QaQuestions.
+
+Args:
+  parent: string, Required. The parent resource of the questions. (required)
+  pageSize: integer, Optional. The maximum number of questions to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
+  pageToken: string, Optional. The value returned by the last `ListQaQuestionsResponse`. This value indicates that this is a continuation of a prior `ListQaQuestions` call and that the system should return the next page of data.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response from a ListQaQuestions request.
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "qaQuestions": [ # The QaQuestions under the parent.
+    { # A single question to be scored by the Insights QA feature.
+      "abbreviation": "A String", # Short, descriptive string, used in the UI where it's not practical to display the full question body. E.g., "Greeting".
+      "answerChoices": [ # A list of valid answers to the question, which the LLM must choose from.
+        { # Message representing a possible answer to the question.
+          "boolValue": True or False, # Boolean value.
+          "key": "A String", # A short string used as an identifier.
+          "naValue": True or False, # A value of "Not Applicable (N/A)". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations.
+          "numValue": 3.14, # Numerical value.
+          "score": 3.14, # Numerical score of the answer, used for generating the overall score of a QaScorecardResult. If the answer uses na_value, this field is unused.
+          "strValue": "A String", # String value.
+        },
+      ],
+      "answerInstructions": "A String", # Instructions describing how to determine the answer.
+      "createTime": "A String", # Output only. The time at which this question was created.
+      "metrics": { # A wrapper representing metrics calculated against a test-set on a LLM that was fine tuned for this question. # Metrics of the underlying tuned LLM over a holdout/test set while fine tuning the underlying LLM for the given question. This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.
+        "accuracy": 3.14, # Output only. Accuracy of the model. Measures the percentage of correct answers the model gave on the test set.
+      },
+      "name": "A String", # Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}
+      "order": 42, # Defines the order of the question within its parent scorecard revision.
+      "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
+      "tags": [ # User-defined list of arbitrary tags for the question. Used for grouping/organization and for weighting the score of each question.
+        "A String",
+      ],
+      "tuningMetadata": { # Metadata about the tuning operation for the question. Will only be set if a scorecard containing this question has been tuned. # Metadata about the tuning operation for the question.This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.
+        "datasetValidationWarnings": [ # A list of any applicable data validation warnings about the question's feedback labels.
+          "A String",
+        ],
+        "totalValidLabelCount": "A String", # Total number of valid labels provided for the question at the time of tuining.
+        "tuningError": "A String", # Error status of the tuning operation for the question. Will only be set if the tuning operation failed.
+      },
+      "updateTime": "A String", # Output only. The most recent time at which the question was updated.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a QaQuestion.
+
+Args:
+  name: string, Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single question to be scored by the Insights QA feature.
+  "abbreviation": "A String", # Short, descriptive string, used in the UI where it's not practical to display the full question body. E.g., "Greeting".
+  "answerChoices": [ # A list of valid answers to the question, which the LLM must choose from.
+    { # Message representing a possible answer to the question.
+      "boolValue": True or False, # Boolean value.
+      "key": "A String", # A short string used as an identifier.
+      "naValue": True or False, # A value of "Not Applicable (N/A)". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations.
+      "numValue": 3.14, # Numerical value.
+      "score": 3.14, # Numerical score of the answer, used for generating the overall score of a QaScorecardResult. If the answer uses na_value, this field is unused.
+      "strValue": "A String", # String value.
+    },
+  ],
+  "answerInstructions": "A String", # Instructions describing how to determine the answer.
+  "createTime": "A String", # Output only. The time at which this question was created.
+  "metrics": { # A wrapper representing metrics calculated against a test-set on a LLM that was fine tuned for this question. # Metrics of the underlying tuned LLM over a holdout/test set while fine tuning the underlying LLM for the given question. This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.
+    "accuracy": 3.14, # Output only. Accuracy of the model. Measures the percentage of correct answers the model gave on the test set.
+  },
+  "name": "A String", # Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}
+  "order": 42, # Defines the order of the question within its parent scorecard revision.
+  "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
+  "tags": [ # User-defined list of arbitrary tags for the question. Used for grouping/organization and for weighting the score of each question.
+    "A String",
+  ],
+  "tuningMetadata": { # Metadata about the tuning operation for the question. Will only be set if a scorecard containing this question has been tuned. # Metadata about the tuning operation for the question.This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.
+    "datasetValidationWarnings": [ # A list of any applicable data validation warnings about the question's feedback labels.
+      "A String",
+    ],
+    "totalValidLabelCount": "A String", # Total number of valid labels provided for the question at the time of tuining.
+    "tuningError": "A String", # Error status of the tuning operation for the question. Will only be set if the tuning operation failed.
+  },
+  "updateTime": "A String", # Output only. The most recent time at which the question was updated.
+}
+
+  updateMask: string, Required. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `abbreviation` * `answer_choices` * `answer_instructions` * `order` * `question_body` * `tags`
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single question to be scored by the Insights QA feature.
+  "abbreviation": "A String", # Short, descriptive string, used in the UI where it's not practical to display the full question body. E.g., "Greeting".
+  "answerChoices": [ # A list of valid answers to the question, which the LLM must choose from.
+    { # Message representing a possible answer to the question.
+      "boolValue": True or False, # Boolean value.
+      "key": "A String", # A short string used as an identifier.
+      "naValue": True or False, # A value of "Not Applicable (N/A)". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations.
+      "numValue": 3.14, # Numerical value.
+      "score": 3.14, # Numerical score of the answer, used for generating the overall score of a QaScorecardResult. If the answer uses na_value, this field is unused.
+      "strValue": "A String", # String value.
+    },
+  ],
+  "answerInstructions": "A String", # Instructions describing how to determine the answer.
+  "createTime": "A String", # Output only. The time at which this question was created.
+  "metrics": { # A wrapper representing metrics calculated against a test-set on a LLM that was fine tuned for this question. # Metrics of the underlying tuned LLM over a holdout/test set while fine tuning the underlying LLM for the given question. This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.
+    "accuracy": 3.14, # Output only. Accuracy of the model. Measures the percentage of correct answers the model gave on the test set.
+  },
+  "name": "A String", # Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}
+  "order": 42, # Defines the order of the question within its parent scorecard revision.
+  "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?"
+  "tags": [ # User-defined list of arbitrary tags for the question. Used for grouping/organization and for weighting the score of each question.
+    "A String",
+  ],
+  "tuningMetadata": { # Metadata about the tuning operation for the question. Will only be set if a scorecard containing this question has been tuned. # Metadata about the tuning operation for the question.This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.
+    "datasetValidationWarnings": [ # A list of any applicable data validation warnings about the question's feedback labels.
+      "A String",
+    ],
+    "totalValidLabelCount": "A String", # Total number of valid labels provided for the question at the time of tuining.
+    "tuningError": "A String", # Error status of the tuning operation for the question. Will only be set if the tuning operation failed.
+  },
+  "updateTime": "A String", # Output only. The most recent time at which the question was updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index c67966b05c..d076da29aa 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -304,6 +304,9 @@

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. @@ -1391,6 +1394,9 @@

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. @@ -2381,6 +2387,9 @@

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. @@ -3331,6 +3340,9 @@

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. @@ -4218,6 +4230,9 @@

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. diff --git a/docs/dyn/container_v1.projects.locations.html b/docs/dyn/container_v1.projects.locations.html index ee3afcce36..73a9dee9d9 100644 --- a/docs/dyn/container_v1.projects.locations.html +++ b/docs/dyn/container_v1.projects.locations.html @@ -117,6 +117,7 @@

Method Details

{ # ReleaseChannelConfig exposes configuration for a release channel. "channel": "A String", # The release channel this configuration applies to. "defaultVersion": "A String", # The default version for newly created clusters on the channel. + "upgradeTargetVersion": "A String", # The auto upgrade target version for clusters on the channel. "validVersions": [ # List of valid versions for the channel. "A String", ], diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index b4a2379385..0eedc3669a 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -181,6 +181,9 @@

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. @@ -392,6 +395,9 @@

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. @@ -1479,6 +1485,9 @@

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. @@ -2513,6 +2522,9 @@

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. @@ -4245,6 +4257,9 @@

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. diff --git a/docs/dyn/container_v1.projects.zones.html b/docs/dyn/container_v1.projects.zones.html index 8ffa959608..ad1a4a8d63 100644 --- a/docs/dyn/container_v1.projects.zones.html +++ b/docs/dyn/container_v1.projects.zones.html @@ -117,6 +117,7 @@

Method Details

{ # ReleaseChannelConfig exposes configuration for a release channel. "channel": "A String", # The release channel this configuration applies to. "defaultVersion": "A String", # The default version for newly created clusters on the channel. + "upgradeTargetVersion": "A String", # The auto upgrade target version for clusters on the channel. "validVersions": [ # List of valid versions for the channel. "A String", ], diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index a79f63df9f..69cf553abe 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -99,6 +99,9 @@

Instance Methods

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

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

+

+ fetchClusterUpgradeInfo(name, version=None, x__xgafv=None)

+

Fetch upgrade information of a specific cluster.

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

Gets the details for a specific cluster.

@@ -311,6 +314,9 @@

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies logging configuration for Ray clusters. # Optional. Logging configuration for Ray clusters. @@ -617,6 +623,9 @@

Method Details

], }, "managedPrometheusConfig": { # ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus. # Enable Google Cloud Managed Service for Prometheus in the cluster. + "autoMonitoringConfig": { # AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring. # GKE Workload Auto-Monitoring Configuration. + "scope": "A String", # Scope for GKE Workload Auto-Monitoring. + }, "enabled": True or False, # Enable Managed Collection. }, }, @@ -1424,6 +1433,44 @@

Method Details

}
+
+ fetchClusterUpgradeInfo(name, version=None, x__xgafv=None) +
Fetch upgrade information of a specific cluster.
+
+Args:
+  name: string, Required. The name (project, location, cluster) of the cluster to get. Specified in the format `projects/*/locations/*/clusters/*` or `projects/*/zones/*/clusters/*`. (required)
+  version: string, API request version that initiates this operation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ClusterUpgradeInfo contains the upgrade information of a cluster.
+  "autoUpgradeStatus": [ # The auto upgrade status.
+    "A String",
+  ],
+  "endOfExtendedSupportTimestamp": "A String", # The cluster's current minor version's end of extended support timestamp.
+  "endOfStandardSupportTimestamp": "A String", # The cluster's current minor version's end of standard support timestamp.
+  "minorTargetVersion": "A String", # minor_target_version indicates the target version for minor upgrade.
+  "patchTargetVersion": "A String", # patch_target_version indicates the target version for patch upgrade.
+  "pausedReason": [ # The auto upgrade paused reason.
+    "A String",
+  ],
+  "upgradeDetails": [ # The list of past auto upgrades.
+    { # UpgradeDetails contains detailed information of each individual upgrade operation.
+      "endTime": "A String", # The end timestamp of the upgrade.
+      "initialVersion": "A String", # The version before the upgrade.
+      "startTime": "A String", # The start timestamp of the upgrade.
+      "state": "A String", # Output only. The state of the upgrade.
+      "targetVersion": "A String", # The version after the upgrade.
+    },
+  ],
+}
+
+
get(name, clusterId=None, projectId=None, x__xgafv=None, zone=None)
Gets the details for a specific cluster.
@@ -1484,6 +1531,9 @@ 

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies logging configuration for Ray clusters. # Optional. Logging configuration for Ray clusters. @@ -1790,6 +1840,9 @@

Method Details

], }, "managedPrometheusConfig": { # ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus. # Enable Google Cloud Managed Service for Prometheus in the cluster. + "autoMonitoringConfig": { # AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring. # GKE Workload Auto-Monitoring Configuration. + "scope": "A String", # Scope for GKE Workload Auto-Monitoring. + }, "enabled": True or False, # Enable Managed Collection. }, }, @@ -2560,6 +2613,9 @@

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies logging configuration for Ray clusters. # Optional. Logging configuration for Ray clusters. @@ -2866,6 +2922,9 @@

Method Details

], }, "managedPrometheusConfig": { # ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus. # Enable Google Cloud Managed Service for Prometheus in the cluster. + "autoMonitoringConfig": { # AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring. # GKE Workload Auto-Monitoring Configuration. + "scope": "A String", # Scope for GKE Workload Auto-Monitoring. + }, "enabled": True or False, # Enable Managed Collection. }, }, @@ -3596,6 +3655,9 @@

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies logging configuration for Ray clusters. # Optional. Logging configuration for Ray clusters. @@ -4490,6 +4552,9 @@

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies logging configuration for Ray clusters. # Optional. Logging configuration for Ray clusters. @@ -4731,6 +4796,9 @@

Method Details

], }, "managedPrometheusConfig": { # ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus. # Enable Google Cloud Managed Service for Prometheus in the cluster. + "autoMonitoringConfig": { # AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring. # GKE Workload Auto-Monitoring Configuration. + "scope": "A String", # Scope for GKE Workload Auto-Monitoring. + }, "enabled": True or False, # Enable Managed Collection. }, }, diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index d161d45620..e16530d836 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -86,6 +86,9 @@

Instance Methods

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

Deletes a node pool from a cluster.

+

+ fetchNodePoolUpgradeInfo(name, version=None, x__xgafv=None)

+

Fetch upgrade information of a specific nodepool.

get(name, clusterId=None, nodePoolId=None, projectId=None, x__xgafv=None, zone=None)

Retrieves the requested node pool.

@@ -569,6 +572,44 @@

Method Details

}
+
+ fetchNodePoolUpgradeInfo(name, version=None, x__xgafv=None) +
Fetch upgrade information of a specific nodepool.
+
+Args:
+  name: string, Required. The name (project, location, cluster, nodepool) of the nodepool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`. (required)
+  version: string, API request version that initiates this operation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # NodePoolUpgradeInfo contains the upgrade information of a nodepool.
+  "autoUpgradeStatus": [ # The auto upgrade status.
+    "A String",
+  ],
+  "endOfExtendedSupportTimestamp": "A String", # The nodepool's current minor version's end of extended support timestamp.
+  "endOfStandardSupportTimestamp": "A String", # The nodepool's current minor version's end of standard support timestamp.
+  "minorTargetVersion": "A String", # minor_target_version indicates the target version for minor upgrade.
+  "patchTargetVersion": "A String", # patch_target_version indicates the target version for patch upgrade.
+  "pausedReason": [ # The auto upgrade paused reason.
+    "A String",
+  ],
+  "upgradeDetails": [ # The list of past auto upgrades.
+    { # UpgradeDetails contains detailed information of each individual upgrade operation.
+      "endTime": "A String", # The end timestamp of the upgrade.
+      "initialVersion": "A String", # The version before the upgrade.
+      "startTime": "A String", # The start timestamp of the upgrade.
+      "state": "A String", # Output only. The state of the upgrade.
+      "targetVersion": "A String", # The version after the upgrade.
+    },
+  ],
+}
+
+
get(name, clusterId=None, nodePoolId=None, projectId=None, x__xgafv=None, zone=None)
Retrieves the requested node pool.
diff --git a/docs/dyn/container_v1beta1.projects.locations.html b/docs/dyn/container_v1beta1.projects.locations.html
index 87c6205909..6fdff4e6be 100644
--- a/docs/dyn/container_v1beta1.projects.locations.html
+++ b/docs/dyn/container_v1beta1.projects.locations.html
@@ -126,6 +126,7 @@ 

Method Details

], "channel": "A String", # The release channel this configuration applies to. "defaultVersion": "A String", # The default version for newly created clusters on the channel. + "upgradeTargetVersion": "A String", # The auto upgrade target version for clusters on the channel. "validVersions": [ # List of valid versions for the channel. "A String", ], diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index 0ad47ecb41..bd25a1b015 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -94,6 +94,9 @@

Instance Methods

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

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

+

+ fetchClusterUpgradeInfo(name, version=None, x__xgafv=None)

+

Fetch upgrade information of a specific cluster.

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

Gets the details for a specific cluster.

@@ -188,6 +191,9 @@

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies logging configuration for Ray clusters. # Optional. Logging configuration for Ray clusters. @@ -406,6 +412,9 @@

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies logging configuration for Ray clusters. # Optional. Logging configuration for Ray clusters. @@ -712,6 +721,9 @@

Method Details

], }, "managedPrometheusConfig": { # ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus. # Enable Google Cloud Managed Service for Prometheus in the cluster. + "autoMonitoringConfig": { # AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring. # GKE Workload Auto-Monitoring Configuration. + "scope": "A String", # Scope for GKE Workload Auto-Monitoring. + }, "enabled": True or False, # Enable Managed Collection. }, }, @@ -1519,6 +1531,44 @@

Method Details

}
+
+ fetchClusterUpgradeInfo(name, version=None, x__xgafv=None) +
Fetch upgrade information of a specific cluster.
+
+Args:
+  name: string, Required. The name (project, location, cluster) of the cluster to get. Specified in the format `projects/*/locations/*/clusters/*` or `projects/*/zones/*/clusters/*`. (required)
+  version: string, API request version that initiates this operation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ClusterUpgradeInfo contains the upgrade information of a cluster.
+  "autoUpgradeStatus": [ # The auto upgrade status.
+    "A String",
+  ],
+  "endOfExtendedSupportTimestamp": "A String", # The cluster's current minor version's end of extended support timestamp.
+  "endOfStandardSupportTimestamp": "A String", # The cluster's current minor version's end of standard support timestamp.
+  "minorTargetVersion": "A String", # minor_target_version indicates the target version for minor upgrade.
+  "patchTargetVersion": "A String", # patch_target_version indicates the target version for patch upgrade.
+  "pausedReason": [ # The auto upgrade paused reason.
+    "A String",
+  ],
+  "upgradeDetails": [ # The list of past auto upgrades.
+    { # UpgradeDetails contains detailed information of each individual upgrade operation.
+      "endTime": "A String", # The end timestamp of the upgrade.
+      "initialVersion": "A String", # The version before the upgrade.
+      "startTime": "A String", # The start timestamp of the upgrade.
+      "state": "A String", # Output only. The state of the upgrade.
+      "targetVersion": "A String", # The version after the upgrade.
+    },
+  ],
+}
+
+
get(projectId, zone, clusterId, name=None, x__xgafv=None)
Gets the details for a specific cluster.
@@ -1579,6 +1629,9 @@ 

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies logging configuration for Ray clusters. # Optional. Logging configuration for Ray clusters. @@ -1885,6 +1938,9 @@

Method Details

], }, "managedPrometheusConfig": { # ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus. # Enable Google Cloud Managed Service for Prometheus in the cluster. + "autoMonitoringConfig": { # AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring. # GKE Workload Auto-Monitoring Configuration. + "scope": "A String", # Scope for GKE Workload Auto-Monitoring. + }, "enabled": True or False, # Enable Managed Collection. }, }, @@ -2699,6 +2755,9 @@

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies logging configuration for Ray clusters. # Optional. Logging configuration for Ray clusters. @@ -3005,6 +3064,9 @@

Method Details

], }, "managedPrometheusConfig": { # ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus. # Enable Google Cloud Managed Service for Prometheus in the cluster. + "autoMonitoringConfig": { # AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring. # GKE Workload Auto-Monitoring Configuration. + "scope": "A String", # Scope for GKE Workload Auto-Monitoring. + }, "enabled": True or False, # Enable Managed Collection. }, }, @@ -4517,6 +4579,9 @@

Method Details

"networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. }, + "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies logging configuration for Ray clusters. # Optional. Logging configuration for Ray clusters. @@ -4758,6 +4823,9 @@

Method Details

], }, "managedPrometheusConfig": { # ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus. # Enable Google Cloud Managed Service for Prometheus in the cluster. + "autoMonitoringConfig": { # AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring. # GKE Workload Auto-Monitoring Configuration. + "scope": "A String", # Scope for GKE Workload Auto-Monitoring. + }, "enabled": True or False, # Enable Managed Collection. }, }, diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index 1664426bf8..06405dfdf6 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -86,6 +86,9 @@

Instance Methods

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

Deletes a node pool from a cluster.

+

+ fetchNodePoolUpgradeInfo(name, version=None, x__xgafv=None)

+

Fetch upgrade information of a specific nodepool.

get(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)

Retrieves the requested node pool.

@@ -634,6 +637,44 @@

Method Details

}
+
+ fetchNodePoolUpgradeInfo(name, version=None, x__xgafv=None) +
Fetch upgrade information of a specific nodepool.
+
+Args:
+  name: string, Required. The name (project, location, cluster, nodepool) of the nodepool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`. (required)
+  version: string, API request version that initiates this operation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # NodePoolUpgradeInfo contains the upgrade information of a nodepool.
+  "autoUpgradeStatus": [ # The auto upgrade status.
+    "A String",
+  ],
+  "endOfExtendedSupportTimestamp": "A String", # The nodepool's current minor version's end of extended support timestamp.
+  "endOfStandardSupportTimestamp": "A String", # The nodepool's current minor version's end of standard support timestamp.
+  "minorTargetVersion": "A String", # minor_target_version indicates the target version for minor upgrade.
+  "patchTargetVersion": "A String", # patch_target_version indicates the target version for patch upgrade.
+  "pausedReason": [ # The auto upgrade paused reason.
+    "A String",
+  ],
+  "upgradeDetails": [ # The list of past auto upgrades.
+    { # UpgradeDetails contains detailed information of each individual upgrade operation.
+      "endTime": "A String", # The end timestamp of the upgrade.
+      "initialVersion": "A String", # The version before the upgrade.
+      "startTime": "A String", # The start timestamp of the upgrade.
+      "state": "A String", # Output only. The state of the upgrade.
+      "targetVersion": "A String", # The version after the upgrade.
+    },
+  ],
+}
+
+
get(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)
Retrieves the requested node pool.
diff --git a/docs/dyn/container_v1beta1.projects.zones.html b/docs/dyn/container_v1beta1.projects.zones.html
index 93d6bec039..1edf64bfa2 100644
--- a/docs/dyn/container_v1beta1.projects.zones.html
+++ b/docs/dyn/container_v1beta1.projects.zones.html
@@ -123,6 +123,7 @@ 

Method Details

], "channel": "A String", # The release channel this configuration applies to. "defaultVersion": "A String", # The default version for newly created clusters on the channel. + "upgradeTargetVersion": "A String", # The auto upgrade target version for clusters on the channel. "validVersions": [ # List of valid versions for the channel. "A String", ], diff --git a/docs/dyn/content_v2_1.conversionsources.html b/docs/dyn/content_v2_1.conversionsources.html index c53522a758..0713f4470d 100644 --- a/docs/dyn/content_v2_1.conversionsources.html +++ b/docs/dyn/content_v2_1.conversionsources.html @@ -374,7 +374,7 @@

Method Details

"state": "A String", # Output only. Current state of this conversion source. Can't be edited through the API. } - updateMask: string, Required. List of fields being updated. + updateMask: string, Optional. List of fields being updated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/content_v2_1.html b/docs/dyn/content_v2_1.html index b46a46c40a..1ca023310b 100644 --- a/docs/dyn/content_v2_1.html +++ b/docs/dyn/content_v2_1.html @@ -214,16 +214,6 @@

Instance Methods

Returns the returnpolicyonline Resource.

-

- settlementreports() -

-

Returns the settlementreports Resource.

- -

- settlementtransactions() -

-

Returns the settlementtransactions Resource.

-

shippingsettings()

diff --git a/docs/dyn/datacatalog_v1.html b/docs/dyn/datacatalog_v1.html index 8625d1cc56..3870244bc9 100644 --- a/docs/dyn/datacatalog_v1.html +++ b/docs/dyn/datacatalog_v1.html @@ -84,6 +84,11 @@

Instance Methods

Returns the entries Resource.

+

+ organizations() +

+

Returns the organizations Resource.

+

projects()

diff --git a/docs/dyn/datacatalog_v1.organizations.html b/docs/dyn/datacatalog_v1.organizations.html new file mode 100644 index 0000000000..4fe54a0789 --- /dev/null +++ b/docs/dyn/datacatalog_v1.organizations.html @@ -0,0 +1,91 @@ + + + +

Google Cloud Data Catalog API . organizations

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/datacatalog_v1.organizations.locations.html b/docs/dyn/datacatalog_v1.organizations.locations.html new file mode 100644 index 0000000000..b19c0a7b36 --- /dev/null +++ b/docs/dyn/datacatalog_v1.organizations.locations.html @@ -0,0 +1,167 @@ + + + +

Google Cloud Data Catalog API . organizations . locations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ retrieveConfig(name, x__xgafv=None)

+

Retrieves the configuration related to the migration from Data Catalog to Dataplex for a specific organization, including all the projects under it which have a separate configuration set.

+

+ retrieveEffectiveConfig(name, x__xgafv=None)

+

Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.

+

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

+

Sets the configuration related to the migration to Dataplex for an organization or project.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ retrieveConfig(name, x__xgafv=None) +
Retrieves the configuration related to the migration from Data Catalog to Dataplex for a specific organization, including all the projects under it which have a separate configuration set.
+
+Args:
+  name: string, Required. The organization whose config is being retrieved. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The configuration related to the migration from Data Catalog to Dataplex that has been applied to an organization and any projects under it. It is the response message for RetrieveConfig.
+  "config": { # Map of organizations and project resource names and their configuration. The format for the map keys is `organizations/{organizationId}` or `projects/{projectId}`.
+    "a_key": { # The configuration related to the migration to Dataplex applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig.
+      "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex.
+      "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex.
+    },
+  },
+}
+
+ +
+ retrieveEffectiveConfig(name, x__xgafv=None) +
Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.
+
+Args:
+  name: string, Required. The resource whose effective config is being retrieved. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The configuration related to the migration to Dataplex applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig.
+  "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex.
+  "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex.
+}
+
+ +
+ setConfig(name, body=None, x__xgafv=None) +
Sets the configuration related to the migration to Dataplex for an organization or project.
+
+Args:
+  name: string, Required. The organization or project whose config is being specified. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SetConfig.
+  "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex.
+  "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The configuration related to the migration to Dataplex applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig.
+  "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex.
+  "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.tags.html b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.tags.html index 5b28035f03..ff5f464e78 100644 --- a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.tags.html +++ b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.tags.html @@ -112,6 +112,7 @@

Method Details

{ # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags. "column": "A String", # Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`. + "dataplexTransferStatus": "A String", # Output only. Denotes the transfer status of the Tag Template. "fields": { # Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields. "a_key": { # Contains the value and additional information on a field within a Tag. "boolValue": True or False, # The value of a tag field with a boolean type. @@ -141,6 +142,7 @@

Method Details

{ # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags. "column": "A String", # Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`. + "dataplexTransferStatus": "A String", # Output only. Denotes the transfer status of the Tag Template. "fields": { # Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields. "a_key": { # Contains the value and additional information on a field within a Tag. "boolValue": True or False, # The value of a tag field with a boolean type. @@ -200,6 +202,7 @@

Method Details

"tags": [ # Tag details. { # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags. "column": "A String", # Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`. + "dataplexTransferStatus": "A String", # Output only. Denotes the transfer status of the Tag Template. "fields": { # Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields. "a_key": { # Contains the value and additional information on a field within a Tag. "boolValue": True or False, # The value of a tag field with a boolean type. @@ -247,6 +250,7 @@

Method Details

{ # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags. "column": "A String", # Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`. + "dataplexTransferStatus": "A String", # Output only. Denotes the transfer status of the Tag Template. "fields": { # Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields. "a_key": { # Contains the value and additional information on a field within a Tag. "boolValue": True or False, # The value of a tag field with a boolean type. @@ -277,6 +281,7 @@

Method Details

{ # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags. "column": "A String", # Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`. + "dataplexTransferStatus": "A String", # Output only. Denotes the transfer status of the Tag Template. "fields": { # Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields. "a_key": { # Contains the value and additional information on a field within a Tag. "boolValue": True or False, # The value of a tag field with a boolean type. @@ -312,6 +317,7 @@

Method Details

"tags": [ # A list of tags to apply to an entry. A tag can specify a tag template, which must be the template specified in the `ReconcileTagsRequest`. The sole entry and each of its columns must be mentioned at most once. { # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags. "column": "A String", # Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`. + "dataplexTransferStatus": "A String", # Output only. Denotes the transfer status of the Tag Template. "fields": { # Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields. "a_key": { # Contains the value and additional information on a field within a Tag. "boolValue": True or False, # The value of a tag field with a boolean type. diff --git a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.html b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.html index 56e0026643..ae53d40c6b 100644 --- a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.html +++ b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.html @@ -138,6 +138,7 @@

Method Details

"description": "A String", # Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string. "displayName": "A String", # A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string. "name": "A String", # Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name. + "transferredToDataplex": True or False, # Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Catalog Service. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. } entryGroupId: string, Required. The ID of the entry group to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8. @@ -158,6 +159,7 @@

Method Details

"description": "A String", # Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string. "displayName": "A String", # A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string. "name": "A String", # Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name. + "transferredToDataplex": True or False, # Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Catalog Service. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. }
@@ -204,6 +206,7 @@

Method Details

"description": "A String", # Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string. "displayName": "A String", # A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string. "name": "A String", # Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name. + "transferredToDataplex": True or False, # Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Catalog Service. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. }
@@ -277,6 +280,7 @@

Method Details

"description": "A String", # Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string. "displayName": "A String", # A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string. "name": "A String", # Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name. + "transferredToDataplex": True or False, # Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Catalog Service. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. }, ], "nextPageToken": "A String", # Pagination token to specify in the next call to retrieve the next page of results. Empty if there are no more items. @@ -315,6 +319,7 @@

Method Details

"description": "A String", # Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string. "displayName": "A String", # A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string. "name": "A String", # Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name. + "transferredToDataplex": True or False, # Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Catalog Service. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. } updateMask: string, Names of fields whose values to overwrite on an entry group. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. @@ -335,6 +340,7 @@

Method Details

"description": "A String", # Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string. "displayName": "A String", # A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string. "name": "A String", # Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name. + "transferredToDataplex": True or False, # Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Catalog Service. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. } diff --git a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.tags.html b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.tags.html index e07455bc2c..fdd23e0e5d 100644 --- a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.tags.html +++ b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.tags.html @@ -109,6 +109,7 @@

Method Details

{ # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags. "column": "A String", # Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`. + "dataplexTransferStatus": "A String", # Output only. Denotes the transfer status of the Tag Template. "fields": { # Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields. "a_key": { # Contains the value and additional information on a field within a Tag. "boolValue": True or False, # The value of a tag field with a boolean type. @@ -138,6 +139,7 @@

Method Details

{ # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags. "column": "A String", # Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`. + "dataplexTransferStatus": "A String", # Output only. Denotes the transfer status of the Tag Template. "fields": { # Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields. "a_key": { # Contains the value and additional information on a field within a Tag. "boolValue": True or False, # The value of a tag field with a boolean type. @@ -197,6 +199,7 @@

Method Details

"tags": [ # Tag details. { # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags. "column": "A String", # Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`. + "dataplexTransferStatus": "A String", # Output only. Denotes the transfer status of the Tag Template. "fields": { # Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields. "a_key": { # Contains the value and additional information on a field within a Tag. "boolValue": True or False, # The value of a tag field with a boolean type. @@ -244,6 +247,7 @@

Method Details

{ # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags. "column": "A String", # Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`. + "dataplexTransferStatus": "A String", # Output only. Denotes the transfer status of the Tag Template. "fields": { # Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields. "a_key": { # Contains the value and additional information on a field within a Tag. "boolValue": True or False, # The value of a tag field with a boolean type. @@ -274,6 +278,7 @@

Method Details

{ # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags. "column": "A String", # Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`. + "dataplexTransferStatus": "A String", # Output only. Denotes the transfer status of the Tag Template. "fields": { # Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields. "a_key": { # Contains the value and additional information on a field within a Tag. "boolValue": True or False, # The value of a tag field with a boolean type. diff --git a/docs/dyn/datacatalog_v1.projects.locations.html b/docs/dyn/datacatalog_v1.projects.locations.html index e3e7f1bee0..8300c6c7eb 100644 --- a/docs/dyn/datacatalog_v1.projects.locations.html +++ b/docs/dyn/datacatalog_v1.projects.locations.html @@ -97,10 +97,64 @@

Instance Methods

close()

Close httplib2 connections.

+

+ retrieveEffectiveConfig(name, x__xgafv=None)

+

Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.

+

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

+

Sets the configuration related to the migration to Dataplex for an organization or project.

Method Details

close()
Close httplib2 connections.
+
+ retrieveEffectiveConfig(name, x__xgafv=None) +
Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.
+
+Args:
+  name: string, Required. The resource whose effective config is being retrieved. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The configuration related to the migration to Dataplex applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig.
+  "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex.
+  "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex.
+}
+
+ +
+ setConfig(name, body=None, x__xgafv=None) +
Sets the configuration related to the migration to Dataplex for an organization or project.
+
+Args:
+  name: string, Required. The organization or project whose config is being specified. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SetConfig.
+  "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex.
+  "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The configuration related to the migration to Dataplex applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig.
+  "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex.
+  "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html b/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html index c0b8877260..30ebbf1cb0 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html @@ -99,7 +99,7 @@

Method Details

{ # A request to launch a Cloud Dataflow job from a FlexTemplate. "launchParameter": { # Launch FlexTemplate Parameter. # Required. Parameter to launch a job form Flex Template. "containerSpec": { # Container Spec. # Spec about the container image to launch. - "defaultEnvironment": { # The environment values to be set at runtime for flex template. LINT.IfChange # Default runtime environment for the job. + "defaultEnvironment": { # The environment values to be set at runtime for flex template. # Default runtime environment for the job. "additionalExperiments": [ # Additional experiment flags for the job. "A String", ], @@ -177,7 +177,7 @@

Method Details

}, }, "containerSpecGcsPath": "A String", # Cloud Storage path to a file with json serialized ContainerSpec as content. - "environment": { # The environment values to be set at runtime for flex template. LINT.IfChange # The runtime environment for the FlexTemplate job + "environment": { # The environment values to be set at runtime for flex template. # The runtime environment for the FlexTemplate job "additionalExperiments": [ # Additional experiment flags for the job. "A String", ], diff --git a/docs/dyn/dataflow_v1b3.projects.locations.templates.html b/docs/dyn/dataflow_v1b3.projects.locations.templates.html index d2d80449ce..cdf5a18aae 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.templates.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.templates.html @@ -103,7 +103,7 @@

Method Details

The object takes the form of: { # A request to create a Cloud Dataflow job from a template. - "environment": { # The environment values to set at runtime. LINT.IfChange # The runtime environment for the job. + "environment": { # The environment values to set at runtime. # The runtime environment for the job. "additionalExperiments": [ # Optional. Additional experiment flags for the job, specified with the `--experiments` option. "A String", ], @@ -589,7 +589,7 @@

Method Details

The object takes the form of: { # Parameters to provide to the template being launched. Note that the [metadata in the pipeline code] (https://cloud.google.com/dataflow/docs/guides/templates/creating-templates#metadata) determines which runtime parameters are valid. - "environment": { # The environment values to set at runtime. LINT.IfChange # The runtime environment for the job. + "environment": { # The environment values to set at runtime. # The runtime environment for the job. "additionalExperiments": [ # Optional. Additional experiment flags for the job, specified with the `--experiments` option. "A String", ], diff --git a/docs/dyn/dataflow_v1b3.projects.templates.html b/docs/dyn/dataflow_v1b3.projects.templates.html index 560b918201..8ed0224521 100644 --- a/docs/dyn/dataflow_v1b3.projects.templates.html +++ b/docs/dyn/dataflow_v1b3.projects.templates.html @@ -102,7 +102,7 @@

Method Details

The object takes the form of: { # A request to create a Cloud Dataflow job from a template. - "environment": { # The environment values to set at runtime. LINT.IfChange # The runtime environment for the job. + "environment": { # The environment values to set at runtime. # The runtime environment for the job. "additionalExperiments": [ # Optional. Additional experiment flags for the job, specified with the `--experiments` option. "A String", ], @@ -587,7 +587,7 @@

Method Details

The object takes the form of: { # Parameters to provide to the template being launched. Note that the [metadata in the pipeline code] (https://cloud.google.com/dataflow/docs/guides/templates/creating-templates#metadata) determines which runtime parameters are valid. - "environment": { # The environment values to set at runtime. LINT.IfChange # The runtime environment for the job. + "environment": { # The environment values to set at runtime. # The runtime environment for the job. "additionalExperiments": [ # Optional. Additional experiment flags for the job, specified with the `--experiments` option. "A String", ], diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.compilationResults.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.compilationResults.html index f3a22f866c..5c5d4f6d8b 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.compilationResults.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.compilationResults.html @@ -263,7 +263,7 @@

Method Details

filter: string, Optional. Filter for the returned list. orderBy: string, Optional. This field only supports ordering by `name` and `create_time`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. pageSize: integer, Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - pageToken: string, Optional. Page token received from a previous `ListCompilationResults` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCompilationResults` must match the call that provided the page token. + pageToken: string, Optional. Page token received from a previous `ListCompilationResults` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCompilationResults`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -343,7 +343,7 @@

Method Details

name: string, Required. The compilation result's name. (required) filter: string, Optional. Optional filter for the returned list. Filtering is only currently supported on the `file_path` field. pageSize: integer, Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - pageToken: string, Optional. Page token received from a previous `QueryCompilationResultActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryCompilationResultActions` must match the call that provided the page token. + pageToken: string, Optional. Page token received from a previous `QueryCompilationResultActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryCompilationResultActions`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -396,20 +396,6 @@

Method Details

"name": "A String", # The action's name, within `database` and `schema`. "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. }, - "dataPreparation": { # Defines a compiled Data Preparation entity # The data preparation executed by this action. - "contents": "A String", # The data preparation definition, stored as a binary encoded proto. - "dependencyTargets": [ # A list of actions that this action depends on. - { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. - "database": "A String", # The action's database (Google Cloud project ID) . - "name": "A String", # The action's name, within `database` and `schema`. - "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`. - }, - ], - "disabled": True or False, # Whether this action is disabled (i.e. should not be run). - "tags": [ # Arbitrary, user-defined tags on this action. - "A String", - ], - }, "declaration": { # Represents a relation which is not managed by Dataform but which may be referenced by Dataform actions. # The declaration declared by this action. "relationDescriptor": { # Describes a relation and its columns. # Descriptor for the relation and its columns. Used as documentation only, i.e. values here will result in no changes to the relation's metadata. "bigqueryLabels": { # A set of BigQuery labels that should be applied to the relation. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html index 262e5ccb0a..7ec1437b80 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html @@ -250,7 +250,7 @@

Method Details

"tokenStatus": "A String", # Output only. Deprecated: The field does not contain any token status information. Instead use https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories/computeAccessTokenStatus "url": "A String", # Required. The Git remote's URL. }, - "kmsKeyName": "A String", # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]` + "kmsKeyName": "A String", # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}` "labels": { # Optional. Repository user labels. "a_key": "A String", }, @@ -290,7 +290,7 @@

Method Details

"tokenStatus": "A String", # Output only. Deprecated: The field does not contain any token status information. Instead use https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories/computeAccessTokenStatus "url": "A String", # Required. The Git remote's URL. }, - "kmsKeyName": "A String", # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]` + "kmsKeyName": "A String", # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}` "labels": { # Optional. Repository user labels. "a_key": "A String", }, @@ -332,7 +332,7 @@

Method Details

Args: name: string, Required. The repository's name. (required) pageSize: integer, Optional. Maximum number of commits to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - pageToken: string, Optional. Page token received from a previous `FetchRepositoryHistory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchRepositoryHistory` must match the call that provided the page token. + pageToken: string, Optional. Page token received from a previous `FetchRepositoryHistory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchRepositoryHistory`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -422,7 +422,7 @@

Method Details

"tokenStatus": "A String", # Output only. Deprecated: The field does not contain any token status information. Instead use https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories/computeAccessTokenStatus "url": "A String", # Required. The Git remote's URL. }, - "kmsKeyName": "A String", # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]` + "kmsKeyName": "A String", # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}` "labels": { # Optional. Repository user labels. "a_key": "A String", }, @@ -482,7 +482,7 @@

Method Details

filter: string, Optional. Filter for the returned list. orderBy: string, Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. pageSize: integer, Optional. Maximum number of repositories to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - pageToken: string, Optional. Page token received from a previous `ListRepositories` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepositories` must match the call that provided the page token. + pageToken: string, Optional. Page token received from a previous `ListRepositories` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepositories`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -510,7 +510,7 @@

Method Details

"tokenStatus": "A String", # Output only. Deprecated: The field does not contain any token status information. Instead use https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories/computeAccessTokenStatus "url": "A String", # Required. The Git remote's URL. }, - "kmsKeyName": "A String", # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]` + "kmsKeyName": "A String", # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}` "labels": { # Optional. Repository user labels. "a_key": "A String", }, @@ -570,7 +570,7 @@

Method Details

"tokenStatus": "A String", # Output only. Deprecated: The field does not contain any token status information. Instead use https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories/computeAccessTokenStatus "url": "A String", # Required. The Git remote's URL. }, - "kmsKeyName": "A String", # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]` + "kmsKeyName": "A String", # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}` "labels": { # Optional. Repository user labels. "a_key": "A String", }, @@ -610,7 +610,7 @@

Method Details

"tokenStatus": "A String", # Output only. Deprecated: The field does not contain any token status information. Instead use https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories/computeAccessTokenStatus "url": "A String", # Required. The Git remote's URL. }, - "kmsKeyName": "A String", # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]` + "kmsKeyName": "A String", # Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}` "labels": { # Optional. Repository user labels. "a_key": "A String", }, @@ -634,7 +634,7 @@

Method Details

name: string, Required. The repository's name. (required) commitSha: string, Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD. pageSize: integer, Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - pageToken: string, Optional. Page token received from a previous `QueryRepositoryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryRepositoryDirectoryContents` must match the call that provided the page token. + pageToken: string, Optional. Page token received from a previous `QueryRepositoryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token. path: string, Optional. The directory's full path including directory name, relative to root. If left unset, the root is used. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.releaseConfigs.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.releaseConfigs.html index 007507e430..7f4eafe6d4 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.releaseConfigs.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.releaseConfigs.html @@ -130,7 +130,7 @@

Method Details

"disabled": True or False, # Optional. Disables automatic creation of compilation results. "gitCommitish": "A String", # Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` "name": "A String", # Identifier. The release config's name. - "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts, ordered in in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule. + "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule. { # A record of an attempt to create a compilation result for this release config. "compilationResult": "A String", # The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. "errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful. @@ -178,7 +178,7 @@

Method Details

"disabled": True or False, # Optional. Disables automatic creation of compilation results. "gitCommitish": "A String", # Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` "name": "A String", # Identifier. The release config's name. - "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts, ordered in in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule. + "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule. { # A record of an attempt to create a compilation result for this release config. "compilationResult": "A String", # The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. "errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful. @@ -250,7 +250,7 @@

Method Details

"disabled": True or False, # Optional. Disables automatic creation of compilation results. "gitCommitish": "A String", # Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` "name": "A String", # Identifier. The release config's name. - "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts, ordered in in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule. + "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule. { # A record of an attempt to create a compilation result for this release config. "compilationResult": "A String", # The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. "errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful. @@ -277,7 +277,7 @@

Method Details

Args: parent: string, Required. The repository in which to list release configs. Must be in the format `projects/*/locations/*/repositories/*`. (required) pageSize: integer, Optional. Maximum number of release configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - pageToken: string, Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs` must match the call that provided the page token. + pageToken: string, Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -309,7 +309,7 @@

Method Details

"disabled": True or False, # Optional. Disables automatic creation of compilation results. "gitCommitish": "A String", # Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` "name": "A String", # Identifier. The release config's name. - "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts, ordered in in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule. + "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule. { # A record of an attempt to create a compilation result for this release config. "compilationResult": "A String", # The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. "errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful. @@ -377,7 +377,7 @@

Method Details

"disabled": True or False, # Optional. Disables automatic creation of compilation results. "gitCommitish": "A String", # Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` "name": "A String", # Identifier. The release config's name. - "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts, ordered in in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule. + "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule. { # A record of an attempt to create a compilation result for this release config. "compilationResult": "A String", # The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. "errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful. @@ -425,7 +425,7 @@

Method Details

"disabled": True or False, # Optional. Disables automatic creation of compilation results. "gitCommitish": "A String", # Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` "name": "A String", # Identifier. The release config's name. - "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts, ordered in in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule. + "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule. { # A record of an attempt to create a compilation result for this release config. "compilationResult": "A String", # The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. "errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowConfigs.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowConfigs.html index c7fdbbad88..65c9ce1c72 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowConfigs.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowConfigs.html @@ -130,7 +130,7 @@

Method Details

"transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed. }, "name": "A String", # Identifier. The workflow config's name. - "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule. + "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule. { # A record of an attempt to create a workflow invocation for this workflow config. "errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -179,7 +179,7 @@

Method Details

"transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed. }, "name": "A String", # Identifier. The workflow config's name. - "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule. + "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule. { # A record of an attempt to create a workflow invocation for this workflow config. "errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -252,7 +252,7 @@

Method Details

"transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed. }, "name": "A String", # Identifier. The workflow config's name. - "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule. + "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule. { # A record of an attempt to create a workflow invocation for this workflow config. "errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -280,7 +280,7 @@

Method Details

Args: parent: string, Required. The repository in which to list workflow configs. Must be in the format `projects/*/locations/*/repositories/*`. (required) pageSize: integer, Optional. Maximum number of workflow configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - pageToken: string, Optional. Page token received from a previous `ListWorkflowConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowConfigs` must match the call that provided the page token. + pageToken: string, Optional. Page token received from a previous `ListWorkflowConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowConfigs`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -315,7 +315,7 @@

Method Details

"transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed. }, "name": "A String", # Identifier. The workflow config's name. - "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule. + "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule. { # A record of an attempt to create a workflow invocation for this workflow config. "errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -381,7 +381,7 @@

Method Details

"transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed. }, "name": "A String", # Identifier. The workflow config's name. - "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule. + "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule. { # A record of an attempt to create a workflow invocation for this workflow config. "errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -430,7 +430,7 @@

Method Details

"transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed. }, "name": "A String", # Identifier. The workflow config's name. - "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule. + "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule. { # A record of an attempt to create a workflow invocation for this workflow config. "errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful. "code": 42, # The status code, which should be an enum value of google.rpc.Code. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowInvocations.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowInvocations.html index 66f0f0ef4d..0166b26af3 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowInvocations.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowInvocations.html @@ -284,7 +284,7 @@

Method Details

filter: string, Optional. Filter for the returned list. orderBy: string, Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. pageSize: integer, Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - pageToken: string, Optional. Page token received from a previous `ListWorkflowInvocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowInvocations` must match the call that provided the page token. + pageToken: string, Optional. Page token received from a previous `ListWorkflowInvocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowInvocations`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -354,7 +354,7 @@

Method Details

Args: name: string, Required. The workflow invocation's name. (required) pageSize: integer, Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - pageToken: string, Optional. Page token received from a previous `QueryWorkflowInvocationActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryWorkflowInvocationActions` must match the call that provided the page token. + pageToken: string, Optional. Page token received from a previous `QueryWorkflowInvocationActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryWorkflowInvocationActions`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html index 82972dcdce..7ce8b467bc 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html @@ -206,6 +206,7 @@

Method Details

The object takes the form of: { # Represents a Dataform Git workspace. + "createTime": "A String", # Output only. The timestamp of when the workspace was created. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key. "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. }, @@ -222,6 +223,7 @@

Method Details

An object of the form: { # Represents a Dataform Git workspace. + "createTime": "A String", # Output only. The timestamp of when the workspace was created. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key. "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. }, @@ -327,6 +329,7 @@

Method Details

An object of the form: { # Represents a Dataform Git workspace. + "createTime": "A String", # Output only. The timestamp of when the workspace was created. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key. "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. }, @@ -402,7 +405,7 @@

Method Details

filter: string, Optional. Filter for the returned list. orderBy: string, Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. pageSize: integer, Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - pageToken: string, Optional. Page token received from a previous `ListWorkspaces` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkspaces` must match the call that provided the page token. + pageToken: string, Optional. Page token received from a previous `ListWorkspaces` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkspaces`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -418,6 +421,7 @@

Method Details

], "workspaces": [ # List of workspaces. { # Represents a Dataform Git workspace. + "createTime": "A String", # Output only. The timestamp of when the workspace was created. "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key. "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted. }, @@ -579,7 +583,7 @@

Method Details

Args: workspace: string, Required. The workspace's name. (required) pageSize: integer, Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - pageToken: string, Optional. Page token received from a previous `QueryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDirectoryContents` must match the call that provided the page token. + pageToken: string, Optional. Page token received from a previous `QueryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token. path: string, Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used. x__xgafv: string, V1 error format. Allowed values @@ -721,7 +725,7 @@

Method Details

workspace: string, Required. The workspace's name. (required) filter: string, Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the `path` field. See https://google.aip.dev/160 for details. pageSize: integer, Optional. Maximum number of search results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. - pageToken: string, Optional. Page token received from a previous `SearchFilesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchFilesRequest` must match the call that provided the page token. + pageToken: string, Optional. Page token received from a previous `SearchFilesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchFilesRequest`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/datalineage_v1.projects.locations.processes.html b/docs/dyn/datalineage_v1.projects.locations.processes.html index 3f27955d2a..6714e0a6f6 100644 --- a/docs/dyn/datalineage_v1.projects.locations.processes.html +++ b/docs/dyn/datalineage_v1.projects.locations.processes.html @@ -123,7 +123,7 @@

Method Details

"name": "A String", # Immutable. The resource name of the lineage process. Format: `projects/{project}/locations/{location}/processes/{process}`. Can be specified or auto-assigned. {process} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.` "origin": { # Origin of a process. # Optional. The origin of this process and its runs and lineage events. "name": "A String", # If the source_type isn't CUSTOM, the value of this field should be a GCP resource name of the system, which reports lineage. The project and location parts of the resource name must match the project and location of the lineage resource being created. Examples: - `{source_type: COMPOSER, name: "projects/foo/locations/us/environments/bar"}` - `{source_type: BIGQUERY, name: "projects/foo/locations/eu"}` - `{source_type: CUSTOM, name: "myCustomIntegration"}` - "sourceType": "A String", # Type of the source. Use of a source_type other than `CUSTOM` for process creation or updating is highly discouraged, and may be restricted in the future without notice. + "sourceType": "A String", # Type of the source. Use of a source_type other than `CUSTOM` for process creation or updating is highly discouraged. It may cause additional billing costs and be restricted in the future without notice. }, } @@ -144,7 +144,7 @@

Method Details

"name": "A String", # Immutable. The resource name of the lineage process. Format: `projects/{project}/locations/{location}/processes/{process}`. Can be specified or auto-assigned. {process} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.` "origin": { # Origin of a process. # Optional. The origin of this process and its runs and lineage events. "name": "A String", # If the source_type isn't CUSTOM, the value of this field should be a GCP resource name of the system, which reports lineage. The project and location parts of the resource name must match the project and location of the lineage resource being created. Examples: - `{source_type: COMPOSER, name: "projects/foo/locations/us/environments/bar"}` - `{source_type: BIGQUERY, name: "projects/foo/locations/eu"}` - `{source_type: CUSTOM, name: "myCustomIntegration"}` - "sourceType": "A String", # Type of the source. Use of a source_type other than `CUSTOM` for process creation or updating is highly discouraged, and may be restricted in the future without notice. + "sourceType": "A String", # Type of the source. Use of a source_type other than `CUSTOM` for process creation or updating is highly discouraged. It may cause additional billing costs and be restricted in the future without notice. }, } @@ -207,7 +207,7 @@

Method Details

"name": "A String", # Immutable. The resource name of the lineage process. Format: `projects/{project}/locations/{location}/processes/{process}`. Can be specified or auto-assigned. {process} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.` "origin": { # Origin of a process. # Optional. The origin of this process and its runs and lineage events. "name": "A String", # If the source_type isn't CUSTOM, the value of this field should be a GCP resource name of the system, which reports lineage. The project and location parts of the resource name must match the project and location of the lineage resource being created. Examples: - `{source_type: COMPOSER, name: "projects/foo/locations/us/environments/bar"}` - `{source_type: BIGQUERY, name: "projects/foo/locations/eu"}` - `{source_type: CUSTOM, name: "myCustomIntegration"}` - "sourceType": "A String", # Type of the source. Use of a source_type other than `CUSTOM` for process creation or updating is highly discouraged, and may be restricted in the future without notice. + "sourceType": "A String", # Type of the source. Use of a source_type other than `CUSTOM` for process creation or updating is highly discouraged. It may cause additional billing costs and be restricted in the future without notice. }, } @@ -239,7 +239,7 @@

Method Details

"name": "A String", # Immutable. The resource name of the lineage process. Format: `projects/{project}/locations/{location}/processes/{process}`. Can be specified or auto-assigned. {process} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.` "origin": { # Origin of a process. # Optional. The origin of this process and its runs and lineage events. "name": "A String", # If the source_type isn't CUSTOM, the value of this field should be a GCP resource name of the system, which reports lineage. The project and location parts of the resource name must match the project and location of the lineage resource being created. Examples: - `{source_type: COMPOSER, name: "projects/foo/locations/us/environments/bar"}` - `{source_type: BIGQUERY, name: "projects/foo/locations/eu"}` - `{source_type: CUSTOM, name: "myCustomIntegration"}` - "sourceType": "A String", # Type of the source. Use of a source_type other than `CUSTOM` for process creation or updating is highly discouraged, and may be restricted in the future without notice. + "sourceType": "A String", # Type of the source. Use of a source_type other than `CUSTOM` for process creation or updating is highly discouraged. It may cause additional billing costs and be restricted in the future without notice. }, }, ], @@ -277,7 +277,7 @@

Method Details

"name": "A String", # Immutable. The resource name of the lineage process. Format: `projects/{project}/locations/{location}/processes/{process}`. Can be specified or auto-assigned. {process} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.` "origin": { # Origin of a process. # Optional. The origin of this process and its runs and lineage events. "name": "A String", # If the source_type isn't CUSTOM, the value of this field should be a GCP resource name of the system, which reports lineage. The project and location parts of the resource name must match the project and location of the lineage resource being created. Examples: - `{source_type: COMPOSER, name: "projects/foo/locations/us/environments/bar"}` - `{source_type: BIGQUERY, name: "projects/foo/locations/eu"}` - `{source_type: CUSTOM, name: "myCustomIntegration"}` - "sourceType": "A String", # Type of the source. Use of a source_type other than `CUSTOM` for process creation or updating is highly discouraged, and may be restricted in the future without notice. + "sourceType": "A String", # Type of the source. Use of a source_type other than `CUSTOM` for process creation or updating is highly discouraged. It may cause additional billing costs and be restricted in the future without notice. }, } @@ -299,7 +299,7 @@

Method Details

"name": "A String", # Immutable. The resource name of the lineage process. Format: `projects/{project}/locations/{location}/processes/{process}`. Can be specified or auto-assigned. {process} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.` "origin": { # Origin of a process. # Optional. The origin of this process and its runs and lineage events. "name": "A String", # If the source_type isn't CUSTOM, the value of this field should be a GCP resource name of the system, which reports lineage. The project and location parts of the resource name must match the project and location of the lineage resource being created. Examples: - `{source_type: COMPOSER, name: "projects/foo/locations/us/environments/bar"}` - `{source_type: BIGQUERY, name: "projects/foo/locations/eu"}` - `{source_type: CUSTOM, name: "myCustomIntegration"}` - "sourceType": "A String", # Type of the source. Use of a source_type other than `CUSTOM` for process creation or updating is highly discouraged, and may be restricted in the future without notice. + "sourceType": "A String", # Type of the source. Use of a source_type other than `CUSTOM` for process creation or updating is highly discouraged. It may cause additional billing costs and be restricted in the future without notice. }, } diff --git a/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html b/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html index a08d2b2d07..c40c1e7299 100644 --- a/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html +++ b/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html @@ -302,6 +302,7 @@

Method Details

"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "provider": "A String", # The database provider. + "role": "A String", # Optional. The connection profile role. "sqlserver": { # Specifies connection parameters required specifically for SQL Server databases. # Connection profile for a SQL Server data source. "backups": { # Specifies the backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. # The backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. "gcsBucket": "A String", # Required. The Cloud Storage bucket that stores backups for all replicated databases. @@ -606,6 +607,7 @@

Method Details

"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "provider": "A String", # The database provider. + "role": "A String", # Optional. The connection profile role. "sqlserver": { # Specifies connection parameters required specifically for SQL Server databases. # Connection profile for a SQL Server data source. "backups": { # Specifies the backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. # The backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. "gcsBucket": "A String", # Required. The Cloud Storage bucket that stores backups for all replicated databases. @@ -895,6 +897,7 @@

Method Details

"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "provider": "A String", # The database provider. + "role": "A String", # Optional. The connection profile role. "sqlserver": { # Specifies connection parameters required specifically for SQL Server databases. # Connection profile for a SQL Server data source. "backups": { # Specifies the backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. # The backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. "gcsBucket": "A String", # Required. The Cloud Storage bucket that stores backups for all replicated databases. @@ -1145,6 +1148,7 @@

Method Details

"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "provider": "A String", # The database provider. + "role": "A String", # Optional. The connection profile role. "sqlserver": { # Specifies connection parameters required specifically for SQL Server databases. # Connection profile for a SQL Server data source. "backups": { # Specifies the backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. # The backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. "gcsBucket": "A String", # Required. The Cloud Storage bucket that stores backups for all replicated databases. diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html index 9bc2d895b8..012dd24af2 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.html @@ -136,7 +136,37 @@

Method Details

"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}. "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could be: BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID }, - "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan. + "dataDiscoveryResult": { # The output of a data discovery scan. # Output only. The result of a data discovery scan. + "bigqueryPublishing": { # Describes BigQuery publishing configurations. # Output only. Configuration for metadata publishing. + "dataset": "A String", # Output only. The BigQuery dataset to publish to. It takes the form projects/{project_id}/datasets/{dataset_id}. If not set, the service creates a default publishing dataset. + }, + }, + "dataDiscoverySpec": { # Spec for a data discovery scan. # Settings for a data discovery scan. + "bigqueryPublishingConfig": { # Describes BigQuery publishing configurations. # Optional. Configuration for metadata publishing. + "connection": "A String", # Optional. The BigQuery connection used to create BigLake tables. Must be in the form projects/{project_id}/locations/{location_id}/connections/{connection_id} + "tableType": "A String", # Optional. Determines whether to publish discovered tables as BigLake external tables or non-BigLake external tables. + }, + "storageConfig": { # Configurations related to Cloud Storage as the data source. # Cloud Storage related configurations. + "csvOptions": { # Describes CSV and similar semi-structured data formats. # Optional. Configuration for CSV data. + "delimiter": "A String", # Optional. The delimiter that is used to separate values. The default is , (comma). + "encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. + "headerRows": 42, # Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. + "quote": "A String", # Optional. The character used to quote column values. Accepts " (double quotation mark) or ' (single quotation mark). If unspecified, defaults to " (double quotation mark). + "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for CSV data. If true, all columns are registered as strings. + }, + "excludePatterns": [ # Optional. Defines the data to exclude during discovery. Provide a list of patterns that identify the data to exclude. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names. + "A String", + ], + "includePatterns": [ # Optional. Defines the data to include during discovery when only a subset of the data should be considered. Provide a list of patterns that identify the data to include. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names. + "A String", + ], + "jsonOptions": { # Describes JSON data format. # Optional. Configuration for JSON data. + "encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. + "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). + }, + }, + }, + "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of a data profile scan. "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions. "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action. "message": "A String", # Output only. Additional information about the BigQuery exporting. @@ -195,7 +225,7 @@

Method Details

}, }, }, - "dataProfileSpec": { # DataProfileScan related setting. # DataProfileScan related setting. + "dataProfileSpec": { # DataProfileScan related setting. # Settings for a data profile scan. "excludeFields": { # The specification for fields to include or exclude in data profile scan. # Optional. The fields to exclude from data profile.If specified, the fields will be excluded from data profile, regardless of include_fields value. "fieldNames": [ # Optional. Expected input is a list of fully qualified names of fields as in the schema.Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'. "A String", @@ -214,7 +244,7 @@

Method Details

"rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 "samplingPercent": 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100. }, - "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of the data quality scan. + "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of a data quality scan. "columns": [ # Output only. A list of results at the column level.A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the 'column' field set to it. { # DataQualityColumnResult provides a more detailed, per-column view of the results. "column": "A String", # Output only. The column specified in the DataQualityRule. @@ -224,7 +254,7 @@

Method Details

"dimensions": [ # A list of results at the dimension level.A dimension will have a corresponding DataQualityDimensionResult if and only if there is at least one rule with the 'dimension' field set to it. { # DataQualityDimensionResult provides a more detailed, per-dimension view of the results. "dimension": { # A dimension captures data quality intent about a defined subset of the rules specified. # Output only. The dimension config specified in the DataQualitySpec, as is. - "name": "A String", # The dimension name a rule belongs to. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "name": "A String", # The dimension name a rule belongs to. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" }, "passed": True or False, # Whether the dimension passed or failed. "score": 3.14, # Output only. The dimension-level data quality score for this data scan job if and only if the 'dimension' field is set.The score ranges between 0, 100 (up to two decimal points). @@ -250,7 +280,7 @@

Method Details

"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. - "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation "name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter. "nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null. @@ -301,7 +331,7 @@

Method Details

}, "score": 3.14, # Output only. The overall data quality score.The score ranges between 0, 100 (up to two decimal points). }, - "dataQualitySpec": { # DataQualityScan related setting. # DataQualityScan related setting. + "dataQualitySpec": { # DataQualityScan related setting. # Settings for a data quality scan. "postScanActions": { # The configuration of post scan actions of DataQualityScan. # Optional. Actions to take upon job completion. "bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -326,7 +356,7 @@

Method Details

{ # A rule captures data quality intent about a data source. "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. - "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation "name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter. "nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null. @@ -487,7 +517,7 @@

Method Details

{ # A rule captures data quality intent about a data source. "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. - "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation "name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter. "nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null. @@ -556,7 +586,37 @@

Method Details

"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}. "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could be: BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID }, - "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan. + "dataDiscoveryResult": { # The output of a data discovery scan. # Output only. The result of a data discovery scan. + "bigqueryPublishing": { # Describes BigQuery publishing configurations. # Output only. Configuration for metadata publishing. + "dataset": "A String", # Output only. The BigQuery dataset to publish to. It takes the form projects/{project_id}/datasets/{dataset_id}. If not set, the service creates a default publishing dataset. + }, + }, + "dataDiscoverySpec": { # Spec for a data discovery scan. # Settings for a data discovery scan. + "bigqueryPublishingConfig": { # Describes BigQuery publishing configurations. # Optional. Configuration for metadata publishing. + "connection": "A String", # Optional. The BigQuery connection used to create BigLake tables. Must be in the form projects/{project_id}/locations/{location_id}/connections/{connection_id} + "tableType": "A String", # Optional. Determines whether to publish discovered tables as BigLake external tables or non-BigLake external tables. + }, + "storageConfig": { # Configurations related to Cloud Storage as the data source. # Cloud Storage related configurations. + "csvOptions": { # Describes CSV and similar semi-structured data formats. # Optional. Configuration for CSV data. + "delimiter": "A String", # Optional. The delimiter that is used to separate values. The default is , (comma). + "encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. + "headerRows": 42, # Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. + "quote": "A String", # Optional. The character used to quote column values. Accepts " (double quotation mark) or ' (single quotation mark). If unspecified, defaults to " (double quotation mark). + "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for CSV data. If true, all columns are registered as strings. + }, + "excludePatterns": [ # Optional. Defines the data to exclude during discovery. Provide a list of patterns that identify the data to exclude. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names. + "A String", + ], + "includePatterns": [ # Optional. Defines the data to include during discovery when only a subset of the data should be considered. Provide a list of patterns that identify the data to include. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names. + "A String", + ], + "jsonOptions": { # Describes JSON data format. # Optional. Configuration for JSON data. + "encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. + "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). + }, + }, + }, + "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of a data profile scan. "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions. "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action. "message": "A String", # Output only. Additional information about the BigQuery exporting. @@ -615,7 +675,7 @@

Method Details

}, }, }, - "dataProfileSpec": { # DataProfileScan related setting. # DataProfileScan related setting. + "dataProfileSpec": { # DataProfileScan related setting. # Settings for a data profile scan. "excludeFields": { # The specification for fields to include or exclude in data profile scan. # Optional. The fields to exclude from data profile.If specified, the fields will be excluded from data profile, regardless of include_fields value. "fieldNames": [ # Optional. Expected input is a list of fully qualified names of fields as in the schema.Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'. "A String", @@ -634,7 +694,7 @@

Method Details

"rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 "samplingPercent": 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100. }, - "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of the data quality scan. + "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of a data quality scan. "columns": [ # Output only. A list of results at the column level.A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the 'column' field set to it. { # DataQualityColumnResult provides a more detailed, per-column view of the results. "column": "A String", # Output only. The column specified in the DataQualityRule. @@ -644,7 +704,7 @@

Method Details

"dimensions": [ # A list of results at the dimension level.A dimension will have a corresponding DataQualityDimensionResult if and only if there is at least one rule with the 'dimension' field set to it. { # DataQualityDimensionResult provides a more detailed, per-dimension view of the results. "dimension": { # A dimension captures data quality intent about a defined subset of the rules specified. # Output only. The dimension config specified in the DataQualitySpec, as is. - "name": "A String", # The dimension name a rule belongs to. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "name": "A String", # The dimension name a rule belongs to. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" }, "passed": True or False, # Whether the dimension passed or failed. "score": 3.14, # Output only. The dimension-level data quality score for this data scan job if and only if the 'dimension' field is set.The score ranges between 0, 100 (up to two decimal points). @@ -670,7 +730,7 @@

Method Details

"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. - "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation "name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter. "nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null. @@ -721,7 +781,7 @@

Method Details

}, "score": 3.14, # Output only. The overall data quality score.The score ranges between 0, 100 (up to two decimal points). }, - "dataQualitySpec": { # DataQualityScan related setting. # DataQualityScan related setting. + "dataQualitySpec": { # DataQualityScan related setting. # Settings for a data quality scan. "postScanActions": { # The configuration of post scan actions of DataQualityScan. # Optional. Actions to take upon job completion. "bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -746,7 +806,7 @@

Method Details

{ # A rule captures data quality intent about a data source. "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. - "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation "name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter. "nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null. @@ -891,7 +951,37 @@

Method Details

"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}. "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could be: BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID }, - "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan. + "dataDiscoveryResult": { # The output of a data discovery scan. # Output only. The result of a data discovery scan. + "bigqueryPublishing": { # Describes BigQuery publishing configurations. # Output only. Configuration for metadata publishing. + "dataset": "A String", # Output only. The BigQuery dataset to publish to. It takes the form projects/{project_id}/datasets/{dataset_id}. If not set, the service creates a default publishing dataset. + }, + }, + "dataDiscoverySpec": { # Spec for a data discovery scan. # Settings for a data discovery scan. + "bigqueryPublishingConfig": { # Describes BigQuery publishing configurations. # Optional. Configuration for metadata publishing. + "connection": "A String", # Optional. The BigQuery connection used to create BigLake tables. Must be in the form projects/{project_id}/locations/{location_id}/connections/{connection_id} + "tableType": "A String", # Optional. Determines whether to publish discovered tables as BigLake external tables or non-BigLake external tables. + }, + "storageConfig": { # Configurations related to Cloud Storage as the data source. # Cloud Storage related configurations. + "csvOptions": { # Describes CSV and similar semi-structured data formats. # Optional. Configuration for CSV data. + "delimiter": "A String", # Optional. The delimiter that is used to separate values. The default is , (comma). + "encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. + "headerRows": 42, # Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. + "quote": "A String", # Optional. The character used to quote column values. Accepts " (double quotation mark) or ' (single quotation mark). If unspecified, defaults to " (double quotation mark). + "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for CSV data. If true, all columns are registered as strings. + }, + "excludePatterns": [ # Optional. Defines the data to exclude during discovery. Provide a list of patterns that identify the data to exclude. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names. + "A String", + ], + "includePatterns": [ # Optional. Defines the data to include during discovery when only a subset of the data should be considered. Provide a list of patterns that identify the data to include. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names. + "A String", + ], + "jsonOptions": { # Describes JSON data format. # Optional. Configuration for JSON data. + "encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. + "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). + }, + }, + }, + "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of a data profile scan. "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions. "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action. "message": "A String", # Output only. Additional information about the BigQuery exporting. @@ -950,7 +1040,7 @@

Method Details

}, }, }, - "dataProfileSpec": { # DataProfileScan related setting. # DataProfileScan related setting. + "dataProfileSpec": { # DataProfileScan related setting. # Settings for a data profile scan. "excludeFields": { # The specification for fields to include or exclude in data profile scan. # Optional. The fields to exclude from data profile.If specified, the fields will be excluded from data profile, regardless of include_fields value. "fieldNames": [ # Optional. Expected input is a list of fully qualified names of fields as in the schema.Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'. "A String", @@ -969,7 +1059,7 @@

Method Details

"rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 "samplingPercent": 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100. }, - "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of the data quality scan. + "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of a data quality scan. "columns": [ # Output only. A list of results at the column level.A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the 'column' field set to it. { # DataQualityColumnResult provides a more detailed, per-column view of the results. "column": "A String", # Output only. The column specified in the DataQualityRule. @@ -979,7 +1069,7 @@

Method Details

"dimensions": [ # A list of results at the dimension level.A dimension will have a corresponding DataQualityDimensionResult if and only if there is at least one rule with the 'dimension' field set to it. { # DataQualityDimensionResult provides a more detailed, per-dimension view of the results. "dimension": { # A dimension captures data quality intent about a defined subset of the rules specified. # Output only. The dimension config specified in the DataQualitySpec, as is. - "name": "A String", # The dimension name a rule belongs to. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "name": "A String", # The dimension name a rule belongs to. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" }, "passed": True or False, # Whether the dimension passed or failed. "score": 3.14, # Output only. The dimension-level data quality score for this data scan job if and only if the 'dimension' field is set.The score ranges between 0, 100 (up to two decimal points). @@ -1005,7 +1095,7 @@

Method Details

"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. - "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation "name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter. "nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null. @@ -1056,7 +1146,7 @@

Method Details

}, "score": 3.14, # Output only. The overall data quality score.The score ranges between 0, 100 (up to two decimal points). }, - "dataQualitySpec": { # DataQualityScan related setting. # DataQualityScan related setting. + "dataQualitySpec": { # DataQualityScan related setting. # Settings for a data quality scan. "postScanActions": { # The configuration of post scan actions of DataQualityScan. # Optional. Actions to take upon job completion. "bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -1081,7 +1171,7 @@

Method Details

{ # A rule captures data quality intent about a data source. "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. - "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation "name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter. "nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null. @@ -1187,7 +1277,37 @@

Method Details

"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}. "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could be: BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID }, - "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan. + "dataDiscoveryResult": { # The output of a data discovery scan. # Output only. The result of a data discovery scan. + "bigqueryPublishing": { # Describes BigQuery publishing configurations. # Output only. Configuration for metadata publishing. + "dataset": "A String", # Output only. The BigQuery dataset to publish to. It takes the form projects/{project_id}/datasets/{dataset_id}. If not set, the service creates a default publishing dataset. + }, + }, + "dataDiscoverySpec": { # Spec for a data discovery scan. # Settings for a data discovery scan. + "bigqueryPublishingConfig": { # Describes BigQuery publishing configurations. # Optional. Configuration for metadata publishing. + "connection": "A String", # Optional. The BigQuery connection used to create BigLake tables. Must be in the form projects/{project_id}/locations/{location_id}/connections/{connection_id} + "tableType": "A String", # Optional. Determines whether to publish discovered tables as BigLake external tables or non-BigLake external tables. + }, + "storageConfig": { # Configurations related to Cloud Storage as the data source. # Cloud Storage related configurations. + "csvOptions": { # Describes CSV and similar semi-structured data formats. # Optional. Configuration for CSV data. + "delimiter": "A String", # Optional. The delimiter that is used to separate values. The default is , (comma). + "encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. + "headerRows": 42, # Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. + "quote": "A String", # Optional. The character used to quote column values. Accepts " (double quotation mark) or ' (single quotation mark). If unspecified, defaults to " (double quotation mark). + "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for CSV data. If true, all columns are registered as strings. + }, + "excludePatterns": [ # Optional. Defines the data to exclude during discovery. Provide a list of patterns that identify the data to exclude. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names. + "A String", + ], + "includePatterns": [ # Optional. Defines the data to include during discovery when only a subset of the data should be considered. Provide a list of patterns that identify the data to include. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names. + "A String", + ], + "jsonOptions": { # Describes JSON data format. # Optional. Configuration for JSON data. + "encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. + "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). + }, + }, + }, + "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of a data profile scan. "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions. "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action. "message": "A String", # Output only. Additional information about the BigQuery exporting. @@ -1246,7 +1366,7 @@

Method Details

}, }, }, - "dataProfileSpec": { # DataProfileScan related setting. # DataProfileScan related setting. + "dataProfileSpec": { # DataProfileScan related setting. # Settings for a data profile scan. "excludeFields": { # The specification for fields to include or exclude in data profile scan. # Optional. The fields to exclude from data profile.If specified, the fields will be excluded from data profile, regardless of include_fields value. "fieldNames": [ # Optional. Expected input is a list of fully qualified names of fields as in the schema.Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'. "A String", @@ -1265,7 +1385,7 @@

Method Details

"rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 "samplingPercent": 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100. }, - "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of the data quality scan. + "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of a data quality scan. "columns": [ # Output only. A list of results at the column level.A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the 'column' field set to it. { # DataQualityColumnResult provides a more detailed, per-column view of the results. "column": "A String", # Output only. The column specified in the DataQualityRule. @@ -1275,7 +1395,7 @@

Method Details

"dimensions": [ # A list of results at the dimension level.A dimension will have a corresponding DataQualityDimensionResult if and only if there is at least one rule with the 'dimension' field set to it. { # DataQualityDimensionResult provides a more detailed, per-dimension view of the results. "dimension": { # A dimension captures data quality intent about a defined subset of the rules specified. # Output only. The dimension config specified in the DataQualitySpec, as is. - "name": "A String", # The dimension name a rule belongs to. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "name": "A String", # The dimension name a rule belongs to. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" }, "passed": True or False, # Whether the dimension passed or failed. "score": 3.14, # Output only. The dimension-level data quality score for this data scan job if and only if the 'dimension' field is set.The score ranges between 0, 100 (up to two decimal points). @@ -1301,7 +1421,7 @@

Method Details

"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. - "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation "name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter. "nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null. @@ -1352,7 +1472,7 @@

Method Details

}, "score": 3.14, # Output only. The overall data quality score.The score ranges between 0, 100 (up to two decimal points). }, - "dataQualitySpec": { # DataQualityScan related setting. # DataQualityScan related setting. + "dataQualitySpec": { # DataQualityScan related setting. # Settings for a data quality scan. "postScanActions": { # The configuration of post scan actions of DataQualityScan. # Optional. Actions to take upon job completion. "bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -1377,7 +1497,7 @@

Method Details

{ # A rule captures data quality intent about a data source. "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. - "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation "name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter. "nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null. @@ -1501,7 +1621,37 @@

Method Details

{ # Run DataScan Response. "job": { # A DataScanJob represents an instance of DataScan execution. # DataScanJob created by RunDataScan request. "createTime": "A String", # Output only. The time when the DataScanJob was created. - "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan. + "dataDiscoveryResult": { # The output of a data discovery scan. # Output only. The result of a data discovery scan. + "bigqueryPublishing": { # Describes BigQuery publishing configurations. # Output only. Configuration for metadata publishing. + "dataset": "A String", # Output only. The BigQuery dataset to publish to. It takes the form projects/{project_id}/datasets/{dataset_id}. If not set, the service creates a default publishing dataset. + }, + }, + "dataDiscoverySpec": { # Spec for a data discovery scan. # Output only. Settings for a data discovery scan. + "bigqueryPublishingConfig": { # Describes BigQuery publishing configurations. # Optional. Configuration for metadata publishing. + "connection": "A String", # Optional. The BigQuery connection used to create BigLake tables. Must be in the form projects/{project_id}/locations/{location_id}/connections/{connection_id} + "tableType": "A String", # Optional. Determines whether to publish discovered tables as BigLake external tables or non-BigLake external tables. + }, + "storageConfig": { # Configurations related to Cloud Storage as the data source. # Cloud Storage related configurations. + "csvOptions": { # Describes CSV and similar semi-structured data formats. # Optional. Configuration for CSV data. + "delimiter": "A String", # Optional. The delimiter that is used to separate values. The default is , (comma). + "encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. + "headerRows": 42, # Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. + "quote": "A String", # Optional. The character used to quote column values. Accepts " (double quotation mark) or ' (single quotation mark). If unspecified, defaults to " (double quotation mark). + "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for CSV data. If true, all columns are registered as strings. + }, + "excludePatterns": [ # Optional. Defines the data to exclude during discovery. Provide a list of patterns that identify the data to exclude. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names. + "A String", + ], + "includePatterns": [ # Optional. Defines the data to include during discovery when only a subset of the data should be considered. Provide a list of patterns that identify the data to include. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names. + "A String", + ], + "jsonOptions": { # Describes JSON data format. # Optional. Configuration for JSON data. + "encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. + "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). + }, + }, + }, + "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of a data profile scan. "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions. "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action. "message": "A String", # Output only. Additional information about the BigQuery exporting. @@ -1560,7 +1710,7 @@

Method Details

}, }, }, - "dataProfileSpec": { # DataProfileScan related setting. # Output only. DataProfileScan related setting. + "dataProfileSpec": { # DataProfileScan related setting. # Output only. Settings for a data profile scan. "excludeFields": { # The specification for fields to include or exclude in data profile scan. # Optional. The fields to exclude from data profile.If specified, the fields will be excluded from data profile, regardless of include_fields value. "fieldNames": [ # Optional. Expected input is a list of fully qualified names of fields as in the schema.Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'. "A String", @@ -1579,7 +1729,7 @@

Method Details

"rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 "samplingPercent": 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100. }, - "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of the data quality scan. + "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of a data quality scan. "columns": [ # Output only. A list of results at the column level.A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the 'column' field set to it. { # DataQualityColumnResult provides a more detailed, per-column view of the results. "column": "A String", # Output only. The column specified in the DataQualityRule. @@ -1589,7 +1739,7 @@

Method Details

"dimensions": [ # A list of results at the dimension level.A dimension will have a corresponding DataQualityDimensionResult if and only if there is at least one rule with the 'dimension' field set to it. { # DataQualityDimensionResult provides a more detailed, per-dimension view of the results. "dimension": { # A dimension captures data quality intent about a defined subset of the rules specified. # Output only. The dimension config specified in the DataQualitySpec, as is. - "name": "A String", # The dimension name a rule belongs to. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "name": "A String", # The dimension name a rule belongs to. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" }, "passed": True or False, # Whether the dimension passed or failed. "score": 3.14, # Output only. The dimension-level data quality score for this data scan job if and only if the 'dimension' field is set.The score ranges between 0, 100 (up to two decimal points). @@ -1615,7 +1765,7 @@

Method Details

"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. - "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation "name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter. "nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null. @@ -1666,7 +1816,7 @@

Method Details

}, "score": 3.14, # Output only. The overall data quality score.The score ranges between 0, 100 (up to two decimal points). }, - "dataQualitySpec": { # DataQualityScan related setting. # Output only. DataQualityScan related setting. + "dataQualitySpec": { # DataQualityScan related setting. # Output only. Settings for a data quality scan. "postScanActions": { # The configuration of post scan actions of DataQualityScan. # Optional. Actions to take upon job completion. "bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -1691,7 +1841,7 @@

Method Details

{ # A rule captures data quality intent about a data source. "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. - "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation "name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter. "nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null. diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html index 0dc79175bb..ed63c4fd6e 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html @@ -120,7 +120,7 @@

Method Details

{ # A rule captures data quality intent about a data source. "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. - "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation "name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter. "nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null. @@ -185,7 +185,37 @@

Method Details

{ # A DataScanJob represents an instance of DataScan execution. "createTime": "A String", # Output only. The time when the DataScanJob was created. - "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan. + "dataDiscoveryResult": { # The output of a data discovery scan. # Output only. The result of a data discovery scan. + "bigqueryPublishing": { # Describes BigQuery publishing configurations. # Output only. Configuration for metadata publishing. + "dataset": "A String", # Output only. The BigQuery dataset to publish to. It takes the form projects/{project_id}/datasets/{dataset_id}. If not set, the service creates a default publishing dataset. + }, + }, + "dataDiscoverySpec": { # Spec for a data discovery scan. # Output only. Settings for a data discovery scan. + "bigqueryPublishingConfig": { # Describes BigQuery publishing configurations. # Optional. Configuration for metadata publishing. + "connection": "A String", # Optional. The BigQuery connection used to create BigLake tables. Must be in the form projects/{project_id}/locations/{location_id}/connections/{connection_id} + "tableType": "A String", # Optional. Determines whether to publish discovered tables as BigLake external tables or non-BigLake external tables. + }, + "storageConfig": { # Configurations related to Cloud Storage as the data source. # Cloud Storage related configurations. + "csvOptions": { # Describes CSV and similar semi-structured data formats. # Optional. Configuration for CSV data. + "delimiter": "A String", # Optional. The delimiter that is used to separate values. The default is , (comma). + "encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. + "headerRows": 42, # Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. + "quote": "A String", # Optional. The character used to quote column values. Accepts " (double quotation mark) or ' (single quotation mark). If unspecified, defaults to " (double quotation mark). + "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for CSV data. If true, all columns are registered as strings. + }, + "excludePatterns": [ # Optional. Defines the data to exclude during discovery. Provide a list of patterns that identify the data to exclude. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names. + "A String", + ], + "includePatterns": [ # Optional. Defines the data to include during discovery when only a subset of the data should be considered. Provide a list of patterns that identify the data to include. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names. + "A String", + ], + "jsonOptions": { # Describes JSON data format. # Optional. Configuration for JSON data. + "encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. + "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). + }, + }, + }, + "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of a data profile scan. "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions. "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action. "message": "A String", # Output only. Additional information about the BigQuery exporting. @@ -244,7 +274,7 @@

Method Details

}, }, }, - "dataProfileSpec": { # DataProfileScan related setting. # Output only. DataProfileScan related setting. + "dataProfileSpec": { # DataProfileScan related setting. # Output only. Settings for a data profile scan. "excludeFields": { # The specification for fields to include or exclude in data profile scan. # Optional. The fields to exclude from data profile.If specified, the fields will be excluded from data profile, regardless of include_fields value. "fieldNames": [ # Optional. Expected input is a list of fully qualified names of fields as in the schema.Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'. "A String", @@ -263,7 +293,7 @@

Method Details

"rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 "samplingPercent": 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100. }, - "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of the data quality scan. + "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of a data quality scan. "columns": [ # Output only. A list of results at the column level.A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the 'column' field set to it. { # DataQualityColumnResult provides a more detailed, per-column view of the results. "column": "A String", # Output only. The column specified in the DataQualityRule. @@ -273,7 +303,7 @@

Method Details

"dimensions": [ # A list of results at the dimension level.A dimension will have a corresponding DataQualityDimensionResult if and only if there is at least one rule with the 'dimension' field set to it. { # DataQualityDimensionResult provides a more detailed, per-dimension view of the results. "dimension": { # A dimension captures data quality intent about a defined subset of the rules specified. # Output only. The dimension config specified in the DataQualitySpec, as is. - "name": "A String", # The dimension name a rule belongs to. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "name": "A String", # The dimension name a rule belongs to. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" }, "passed": True or False, # Whether the dimension passed or failed. "score": 3.14, # Output only. The dimension-level data quality score for this data scan job if and only if the 'dimension' field is set.The score ranges between 0, 100 (up to two decimal points). @@ -299,7 +329,7 @@

Method Details

"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. - "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation "name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter. "nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null. @@ -350,7 +380,7 @@

Method Details

}, "score": 3.14, # Output only. The overall data quality score.The score ranges between 0, 100 (up to two decimal points). }, - "dataQualitySpec": { # DataQualityScan related setting. # Output only. DataQualityScan related setting. + "dataQualitySpec": { # DataQualityScan related setting. # Output only. Settings for a data quality scan. "postScanActions": { # The configuration of post scan actions of DataQualityScan. # Optional. Actions to take upon job completion. "bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -375,7 +405,7 @@

Method Details

{ # A rule captures data quality intent about a data source. "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. - "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation "name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter. "nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null. @@ -449,7 +479,37 @@

Method Details

"dataScanJobs": [ # DataScanJobs (BASIC view only) under a given dataScan. { # A DataScanJob represents an instance of DataScan execution. "createTime": "A String", # Output only. The time when the DataScanJob was created. - "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan. + "dataDiscoveryResult": { # The output of a data discovery scan. # Output only. The result of a data discovery scan. + "bigqueryPublishing": { # Describes BigQuery publishing configurations. # Output only. Configuration for metadata publishing. + "dataset": "A String", # Output only. The BigQuery dataset to publish to. It takes the form projects/{project_id}/datasets/{dataset_id}. If not set, the service creates a default publishing dataset. + }, + }, + "dataDiscoverySpec": { # Spec for a data discovery scan. # Output only. Settings for a data discovery scan. + "bigqueryPublishingConfig": { # Describes BigQuery publishing configurations. # Optional. Configuration for metadata publishing. + "connection": "A String", # Optional. The BigQuery connection used to create BigLake tables. Must be in the form projects/{project_id}/locations/{location_id}/connections/{connection_id} + "tableType": "A String", # Optional. Determines whether to publish discovered tables as BigLake external tables or non-BigLake external tables. + }, + "storageConfig": { # Configurations related to Cloud Storage as the data source. # Cloud Storage related configurations. + "csvOptions": { # Describes CSV and similar semi-structured data formats. # Optional. Configuration for CSV data. + "delimiter": "A String", # Optional. The delimiter that is used to separate values. The default is , (comma). + "encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. + "headerRows": 42, # Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. + "quote": "A String", # Optional. The character used to quote column values. Accepts " (double quotation mark) or ' (single quotation mark). If unspecified, defaults to " (double quotation mark). + "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for CSV data. If true, all columns are registered as strings. + }, + "excludePatterns": [ # Optional. Defines the data to exclude during discovery. Provide a list of patterns that identify the data to exclude. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names. + "A String", + ], + "includePatterns": [ # Optional. Defines the data to include during discovery when only a subset of the data should be considered. Provide a list of patterns that identify the data to include. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names. + "A String", + ], + "jsonOptions": { # Describes JSON data format. # Optional. Configuration for JSON data. + "encoding": "A String", # Optional. The character encoding of the data. The default is UTF-8. + "typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). + }, + }, + }, + "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of a data profile scan. "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions. "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action. "message": "A String", # Output only. Additional information about the BigQuery exporting. @@ -508,7 +568,7 @@

Method Details

}, }, }, - "dataProfileSpec": { # DataProfileScan related setting. # Output only. DataProfileScan related setting. + "dataProfileSpec": { # DataProfileScan related setting. # Output only. Settings for a data profile scan. "excludeFields": { # The specification for fields to include or exclude in data profile scan. # Optional. The fields to exclude from data profile.If specified, the fields will be excluded from data profile, regardless of include_fields value. "fieldNames": [ # Optional. Expected input is a list of fully qualified names of fields as in the schema.Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'. "A String", @@ -527,7 +587,7 @@

Method Details

"rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 "samplingPercent": 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100. }, - "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of the data quality scan. + "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of a data quality scan. "columns": [ # Output only. A list of results at the column level.A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the 'column' field set to it. { # DataQualityColumnResult provides a more detailed, per-column view of the results. "column": "A String", # Output only. The column specified in the DataQualityRule. @@ -537,7 +597,7 @@

Method Details

"dimensions": [ # A list of results at the dimension level.A dimension will have a corresponding DataQualityDimensionResult if and only if there is at least one rule with the 'dimension' field set to it. { # DataQualityDimensionResult provides a more detailed, per-dimension view of the results. "dimension": { # A dimension captures data quality intent about a defined subset of the rules specified. # Output only. The dimension config specified in the DataQualitySpec, as is. - "name": "A String", # The dimension name a rule belongs to. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "name": "A String", # The dimension name a rule belongs to. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" }, "passed": True or False, # Whether the dimension passed or failed. "score": 3.14, # Output only. The dimension-level data quality score for this data scan job if and only if the 'dimension' field is set.The score ranges between 0, 100 (up to two decimal points). @@ -563,7 +623,7 @@

Method Details

"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. - "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation "name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter. "nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null. @@ -614,7 +674,7 @@

Method Details

}, "score": 3.14, # Output only. The overall data quality score.The score ranges between 0, 100 (up to two decimal points). }, - "dataQualitySpec": { # DataQualityScan related setting. # Output only. DataQualityScan related setting. + "dataQualitySpec": { # DataQualityScan related setting. # Output only. Settings for a data quality scan. "postScanActions": { # The configuration of post scan actions of DataQualityScan. # Optional. Actions to take upon job completion. "bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -639,7 +699,7 @@

Method Details

{ # A rule captures data quality intent about a data source. "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. - "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation "name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter. "nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null. diff --git a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html index 6b06ae4f57..8754387caf 100644 --- a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html +++ b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html @@ -115,6 +115,7 @@

Method Details

"a_key": { # An aspect is a single piece of metadata describing an entry. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. @@ -167,6 +168,7 @@

Method Details

"a_key": { # An aspect is a single piece of metadata describing an entry. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. @@ -225,6 +227,7 @@

Method Details

"a_key": { # An aspect is a single piece of metadata describing an entry. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. @@ -292,6 +295,7 @@

Method Details

"a_key": { # An aspect is a single piece of metadata describing an entry. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. @@ -355,6 +359,7 @@

Method Details

"a_key": { # An aspect is a single piece of metadata describing an entry. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. @@ -425,6 +430,7 @@

Method Details

"a_key": { # An aspect is a single piece of metadata describing an entry. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. @@ -480,6 +486,7 @@

Method Details

"a_key": { # An aspect is a single piece of metadata describing an entry. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. diff --git a/docs/dyn/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html index b9bb9d3420..7ed6b9d14b 100644 --- a/docs/dyn/dataplex_v1.projects.locations.html +++ b/docs/dyn/dataplex_v1.projects.locations.html @@ -266,6 +266,7 @@

Method Details

"a_key": { # An aspect is a single piece of metadata describing an entry. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. @@ -333,6 +334,7 @@

Method Details

"a_key": { # An aspect is a single piece of metadata describing an entry. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. @@ -377,6 +379,7 @@

Method Details

"a_key": { # An aspect is a single piece of metadata describing an entry. "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. diff --git a/docs/dyn/datastore_v1.projects.html b/docs/dyn/datastore_v1.projects.html index ac5c894e49..014fc47370 100644 --- a/docs/dyn/datastore_v1.projects.html +++ b/docs/dyn/datastore_v1.projects.html @@ -229,6 +229,7 @@

Method Details

"mutations": [ # The mutations to perform. When mode is `TRANSACTIONAL`, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single `Commit` request: - `insert` followed by `insert` - `update` followed by `insert` - `upsert` followed by `insert` - `delete` followed by `update` When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single entity. { # A mutation to apply to an entity. "baseVersion": "A String", # The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts. + "conflictResolutionStrategy": "A String", # The strategy to use when a conflict is detected. Defaults to `SERVER_VALUE`. If this is set, then `conflict_detection_strategy` must also be set. "delete": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only. "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. @@ -301,6 +302,127 @@

Method Details

"A String", ], }, + "propertyTransforms": [ # Optional. The transforms to perform on the entity. This field can be set only when the operation is `insert`, `update`, or `upsert`. If present, the transforms are be applied to the entity regardless of the property mask, in order, after the operation. + { # A transformation of an entity property. + "appendMissingElements": { # An array value. # Appends the given elements in order if they are not already present in the current property value. If the property is not an array, or if the property does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and the null value is equal to the null value. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform result will be the null value. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "increment": { # A message that can hold any of the supported value types and associated metadata. # Adds the given value to the property's current value. This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the given value. If either of the given value or the current property value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follows IEEE 754 semantics. If there is positive/negative integer overflow, the property is resolved to the largest magnitude positive/negative integer. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # 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. # A geo point value representing a point on the surface of Earth. + "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]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, + "maximum": { # A message that can hold any of the supported value types and associated metadata. # Sets the property to the maximum of its current value and the given value. This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the given value. If a maximum operation is applied where the property and the input value are of mixed types (that is - one is an integer and one is a double) the property takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # 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. # A geo point value representing a point on the surface of Earth. + "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]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, + "minimum": { # A message that can hold any of the supported value types and associated metadata. # Sets the property to the minimum of its current value and the given value. This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the input value. If a minimum operation is applied where the property and the input value are of mixed types (that is - one is an integer and one is a double) the property takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # 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. # A geo point value representing a point on the surface of Earth. + "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]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, + "property": "A String", # Optional. The name of the property. Property paths (a list of property names separated by dots (`.`)) may be used to refer to properties inside entity values. For example `foo.bar` means the property `bar` inside the entity property `foo`. If a property name contains a dot `.` or a backlslash `\`, then that name must be escaped. + "removeAllFromArray": { # An array value. # Removes all of the given elements from the array in the property. If the property is not an array, or if the property does not yet exist, it is set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and the null value is equal to the null value. This will remove all equivalent values if there are duplicates. The corresponding transform result will be the null value. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "setToServerValue": "A String", # Sets the property to the given server value. + }, + ], "update": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # The entity to update. The entity must already exist. Must have a complete key path. "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. @@ -450,6 +572,43 @@

Method Details

}, ], }, + "transformResults": [ # The results of applying each PropertyTransform, in the same order of the request. + { # A message that can hold any of the supported value types and associated metadata. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # 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. # A geo point value representing a point on the surface of Earth. + "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]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, + ], "updateTime": "A String", # The update time of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the timestamp will be the update timestamp of the current entity. This field will not be set after a 'delete'. "version": "A String", # The version of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the version will be the version of the current entity or, if no entity is present, a version that is strictly greater than the version of any previous entity and less than the version of any possible future entity. }, @@ -858,7 +1017,7 @@

Method Details

}, }, ], - "nestedQuery": { # A query for entities. # Nested query for aggregation + "nestedQuery": { # A query for entities. The query stages are executed in the following order: 1. kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6. limit 7. find_nearest # Nested query for aggregation "distinctOn": [ # The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). Requires: * If `order` is specified, the set of distinct on properties must appear before the non-distinct on properties in `order`. { # A reference to a property relative to the kind expressions. "name": "A String", # A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations. @@ -914,6 +1073,50 @@

Method Details

}, }, }, + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential Nearest Neighbors Search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "distanceMeasure": "A String", # Required. The Distance Measure to use, required. + "distanceResultProperty": "A String", # Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to entity property limitations. + "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold + "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100. + "queryVector": { # A message that can hold any of the supported value types and associated metadata. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # 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. # A geo point value representing a point on the surface of Earth. + "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]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, + "vectorProperty": { # A reference to a property relative to the kind expressions. # Required. An indexed vector property to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. + "name": "A String", # A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations. + }, + }, "kind": [ # The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified. { # A representation of a kind. "name": "A String", # The name of the kind. @@ -1137,7 +1340,7 @@

Method Details

}, }, ], - "nestedQuery": { # A query for entities. # Nested query for aggregation + "nestedQuery": { # A query for entities. The query stages are executed in the following order: 1. kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6. limit 7. find_nearest # Nested query for aggregation "distinctOn": [ # The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). Requires: * If `order` is specified, the set of distinct on properties must appear before the non-distinct on properties in `order`. { # A reference to a property relative to the kind expressions. "name": "A String", # A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations. @@ -1193,6 +1396,50 @@

Method Details

}, }, }, + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential Nearest Neighbors Search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "distanceMeasure": "A String", # Required. The Distance Measure to use, required. + "distanceResultProperty": "A String", # Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to entity property limitations. + "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold + "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100. + "queryVector": { # A message that can hold any of the supported value types and associated metadata. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # 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. # A geo point value representing a point on the surface of Earth. + "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]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, + "vectorProperty": { # A reference to a property relative to the kind expressions. # Required. An indexed vector property to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. + "name": "A String", # A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations. + }, + }, "kind": [ # The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified. { # A representation of a kind. "name": "A String", # The name of the kind. @@ -1330,7 +1577,7 @@

Method Details

"A String", ], }, - "query": { # A query for entities. # The query to run. + "query": { # A query for entities. The query stages are executed in the following order: 1. kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6. limit 7. find_nearest # The query to run. "distinctOn": [ # The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). Requires: * If `order` is specified, the set of distinct on properties must appear before the non-distinct on properties in `order`. { # A reference to a property relative to the kind expressions. "name": "A String", # A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations. @@ -1386,6 +1633,50 @@

Method Details

}, }, }, + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential Nearest Neighbors Search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "distanceMeasure": "A String", # Required. The Distance Measure to use, required. + "distanceResultProperty": "A String", # Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to entity property limitations. + "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold + "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100. + "queryVector": { # A message that can hold any of the supported value types and associated metadata. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # 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. # A geo point value representing a point on the surface of Earth. + "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]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, + "vectorProperty": { # A reference to a property relative to the kind expressions. # Required. An indexed vector property to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. + "name": "A String", # A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations. + }, + }, "kind": [ # The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified. { # A representation of a kind. "name": "A String", # The name of the kind. @@ -1521,7 +1812,7 @@

Method Details

], }, }, - "query": { # A query for entities. # The parsed form of the `GqlQuery` from the request, if it was set. + "query": { # A query for entities. The query stages are executed in the following order: 1. kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6. limit 7. find_nearest # The parsed form of the `GqlQuery` from the request, if it was set. "distinctOn": [ # The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). Requires: * If `order` is specified, the set of distinct on properties must appear before the non-distinct on properties in `order`. { # A reference to a property relative to the kind expressions. "name": "A String", # A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations. @@ -1577,6 +1868,50 @@

Method Details

}, }, }, + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential Nearest Neighbors Search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "distanceMeasure": "A String", # Required. The Distance Measure to use, required. + "distanceResultProperty": "A String", # Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to entity property limitations. + "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold + "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100. + "queryVector": { # A message that can hold any of the supported value types and associated metadata. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # 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. # A geo point value representing a point on the surface of Earth. + "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]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, + "vectorProperty": { # A reference to a property relative to the kind expressions. # Required. An indexed vector property to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. + "name": "A String", # A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations. + }, + }, "kind": [ # The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified. { # A representation of a kind. "name": "A String", # The name of the kind. diff --git a/docs/dyn/datastore_v1beta3.projects.html b/docs/dyn/datastore_v1beta3.projects.html index 00450ec0c8..ba889141df 100644 --- a/docs/dyn/datastore_v1beta3.projects.html +++ b/docs/dyn/datastore_v1beta3.projects.html @@ -208,6 +208,7 @@

Method Details

"mutations": [ # The mutations to perform. When mode is `TRANSACTIONAL`, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single `Commit` request: - `insert` followed by `insert` - `update` followed by `insert` - `upsert` followed by `insert` - `delete` followed by `update` When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single entity. { # A mutation to apply to an entity. "baseVersion": "A String", # The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts. + "conflictResolutionStrategy": "A String", # The strategy to use when a conflict is detected. Defaults to `SERVER_VALUE`. If this is set, then `conflict_detection_strategy` must also be set. "delete": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only. "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. @@ -277,6 +278,124 @@

Method Details

"A String", ], }, + "propertyTransforms": [ # Optional. The transforms to perform on the entity. This field can be set only when the operation is `insert`, `update`, or `upsert`. If present, the transforms are be applied to the entity regardless of the property mask, in order, after the operation. + { # A transformation of an entity property. + "appendMissingElements": { # An array value. # Appends the given elements in order if they are not already present in the current property value. If the property is not an array, or if the property does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and the null value is equal to the null value. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform result will be the null value. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "increment": { # A message that can hold any of the supported value types and associated metadata. # Adds the given value to the property's current value. This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the given value. If either of the given value or the current property value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follows IEEE 754 semantics. If there is positive/negative integer overflow, the property is resolved to the largest magnitude positive/negative integer. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # 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. # A geo point value representing a point on the surface of Earth. + "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]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, + "maximum": { # A message that can hold any of the supported value types and associated metadata. # Sets the property to the maximum of its current value and the given value. This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the given value. If a maximum operation is applied where the property and the input value are of mixed types (that is - one is an integer and one is a double) the property takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # 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. # A geo point value representing a point on the surface of Earth. + "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]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, + "minimum": { # A message that can hold any of the supported value types and associated metadata. # Sets the property to the minimum of its current value and the given value. This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the input value. If a minimum operation is applied where the property and the input value are of mixed types (that is - one is an integer and one is a double) the property takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # 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. # A geo point value representing a point on the surface of Earth. + "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]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, + "property": "A String", # Optional. The name of the property. Property paths (a list of property names separated by dots (`.`)) may be used to refer to properties inside entity values. For example `foo.bar` means the property `bar` inside the entity property `foo`. If a property name contains a dot `.` or a backlslash `\`, then that name must be escaped. + "removeAllFromArray": { # An array value. # Removes all of the given elements from the array in the property. If the property is not an array, or if the property does not yet exist, it is set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and the null value is equal to the null value. This will remove all equivalent values if there are duplicates. The corresponding transform result will be the null value. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "setToServerValue": "A String", # Sets the property to the given server value. + }, + ], "update": { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # The entity to update. The entity must already exist. Must have a complete key path. "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. @@ -413,6 +532,42 @@

Method Details

}, ], }, + "transformResults": [ # The results of applying each PropertyTransform, in the same order of the request. + { # A message that can hold any of the supported value types and associated metadata. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # 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. # A geo point value representing a point on the surface of Earth. + "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]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, + ], "updateTime": "A String", # The update time of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the timestamp will be the update timestamp of the current entity. This field will not be set after a 'delete'. "version": "A String", # The version of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the version will be the version of the current entity or, if no entity is present, a version that is strictly greater than the version of any previous entity and less than the version of any possible future entity. }, @@ -697,7 +852,7 @@

Method Details

}, }, ], - "nestedQuery": { # A query for entities. # Nested query for aggregation + "nestedQuery": { # A query for entities. The query stages are executed in the following order: 1. kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6. limit 7. find_nearest # Nested query for aggregation "distinctOn": [ # The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). Requires: * If `order` is specified, the set of distinct on properties must appear before the non-distinct on properties in `order`. { # A reference to a property relative to the kind expressions. "name": "A String", # A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations. @@ -752,6 +907,49 @@

Method Details

}, }, }, + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential Nearest Neighbors Search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "distanceMeasure": "A String", # Required. The Distance Measure to use, required. + "distanceResultProperty": "A String", # Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to entity property limitations. + "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold + "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100. + "queryVector": { # A message that can hold any of the supported value types and associated metadata. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # 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. # A geo point value representing a point on the surface of Earth. + "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]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, + "vectorProperty": { # A reference to a property relative to the kind expressions. # Required. An indexed vector property to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. + "name": "A String", # A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations. + }, + }, "kind": [ # The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified. { # A representation of a kind. "name": "A String", # The name of the kind. @@ -962,7 +1160,7 @@

Method Details

}, }, ], - "nestedQuery": { # A query for entities. # Nested query for aggregation + "nestedQuery": { # A query for entities. The query stages are executed in the following order: 1. kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6. limit 7. find_nearest # Nested query for aggregation "distinctOn": [ # The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). Requires: * If `order` is specified, the set of distinct on properties must appear before the non-distinct on properties in `order`. { # A reference to a property relative to the kind expressions. "name": "A String", # A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations. @@ -1017,6 +1215,49 @@

Method Details

}, }, }, + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential Nearest Neighbors Search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "distanceMeasure": "A String", # Required. The Distance Measure to use, required. + "distanceResultProperty": "A String", # Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to entity property limitations. + "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold + "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100. + "queryVector": { # A message that can hold any of the supported value types and associated metadata. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # 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. # A geo point value representing a point on the surface of Earth. + "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]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, + "vectorProperty": { # A reference to a property relative to the kind expressions. # Required. An indexed vector property to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. + "name": "A String", # A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations. + }, + }, "kind": [ # The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified. { # A representation of a kind. "name": "A String", # The name of the kind. @@ -1149,7 +1390,7 @@

Method Details

"A String", ], }, - "query": { # A query for entities. # The query to run. + "query": { # A query for entities. The query stages are executed in the following order: 1. kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6. limit 7. find_nearest # The query to run. "distinctOn": [ # The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). Requires: * If `order` is specified, the set of distinct on properties must appear before the non-distinct on properties in `order`. { # A reference to a property relative to the kind expressions. "name": "A String", # A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations. @@ -1204,6 +1445,49 @@

Method Details

}, }, }, + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential Nearest Neighbors Search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "distanceMeasure": "A String", # Required. The Distance Measure to use, required. + "distanceResultProperty": "A String", # Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to entity property limitations. + "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold + "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100. + "queryVector": { # A message that can hold any of the supported value types and associated metadata. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # 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. # A geo point value representing a point on the surface of Earth. + "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]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, + "vectorProperty": { # A reference to a property relative to the kind expressions. # Required. An indexed vector property to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. + "name": "A String", # A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations. + }, + }, "kind": [ # The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified. { # A representation of a kind. "name": "A String", # The name of the kind. @@ -1329,7 +1613,7 @@

Method Details

], }, }, - "query": { # A query for entities. # The parsed form of the `GqlQuery` from the request, if it was set. + "query": { # A query for entities. The query stages are executed in the following order: 1. kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6. limit 7. find_nearest # The parsed form of the `GqlQuery` from the request, if it was set. "distinctOn": [ # The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). Requires: * If `order` is specified, the set of distinct on properties must appear before the non-distinct on properties in `order`. { # A reference to a property relative to the kind expressions. "name": "A String", # A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations. @@ -1384,6 +1668,49 @@

Method Details

}, }, }, + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential Nearest Neighbors Search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "distanceMeasure": "A String", # Required. The Distance Measure to use, required. + "distanceResultProperty": "A String", # Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to entity property limitations. + "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold + "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100. + "queryVector": { # A message that can hold any of the supported value types and associated metadata. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # 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. # A geo point value representing a point on the surface of Earth. + "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]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, + "vectorProperty": { # A reference to a property relative to the kind expressions. # Required. An indexed vector property to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. + "name": "A String", # A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations. + }, + }, "kind": [ # The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified. { # A representation of a kind. "name": "A String", # The name of the kind. diff --git a/docs/dyn/developerconnect_v1.projects.locations.connections.gitRepositoryLinks.html b/docs/dyn/developerconnect_v1.projects.locations.connections.gitRepositoryLinks.html index beabe418b4..617735b213 100644 --- a/docs/dyn/developerconnect_v1.projects.locations.connections.gitRepositoryLinks.html +++ b/docs/dyn/developerconnect_v1.projects.locations.connections.gitRepositoryLinks.html @@ -104,6 +104,12 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

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

+

ProcessGitLabEnterpriseWebhook is called by the external GitLab Enterprise instances for notifying events.

+

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

+

ProcessGitLabWebhook is called by the GitLab.com for notifying events.

Method Details

close() @@ -396,4 +402,70 @@

Method Details

+
+ processGitLabEnterpriseWebhook(name, body=None, x__xgafv=None) +
ProcessGitLabEnterpriseWebhook is called by the external GitLab Enterprise instances for notifying events.
+
+Args:
+  name: string, Required. The GitRepositoryLink resource where the webhook will be received. Format: `projects/*/locations/*/connections/*/gitRepositoryLinks/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # RPC request object accepted by the ProcessGitLabEnterpriseWebhook RPC method.
+  "body": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # Required. HTTP request body.
+    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+    "data": "A String", # The HTTP request/response body as raw binary.
+    "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ processGitLabWebhook(name, body=None, x__xgafv=None) +
ProcessGitLabWebhook is called by the GitLab.com for notifying events.
+
+Args:
+  name: string, Required. The GitRepositoryLink resource where the webhook will be received. Format: `projects/*/locations/*/connections/*/gitRepositoryLinks/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # RPC request object accepted by the ProcessGitLabWebhook RPC method.
+  "body": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # Required. HTTP request body.
+    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+    "data": "A String", # The HTTP request/response body as raw binary.
+    "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/developerconnect_v1.projects.locations.connections.html b/docs/dyn/developerconnect_v1.projects.locations.connections.html index 931706fd27..33aea76f19 100644 --- a/docs/dyn/developerconnect_v1.projects.locations.connections.html +++ b/docs/dyn/developerconnect_v1.projects.locations.connections.html @@ -109,6 +109,9 @@

Instance Methods

patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)

Updates the parameters of a single Connection.

+

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

+

ProcessGitHubEnterpriseWebhook is called by the external GitHub Enterprise instances for notifying events.

Method Details

close() @@ -630,7 +633,7 @@

Method Details

allowMissing: boolean, Optional. If set to true, and the connection is not found a new connection will be created. In this situation `update_mask` is ignored. The creation will succeed only if the input connection has all the necessary information (e.g a github_config with both user_oauth_token and installation_id properties). requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - updateMask: string, Optional. Required. Field mask is used to specify the fields to be overwritten in the Connection resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Connection resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. validateOnly: boolean, Optional. If set, validate the request, but do not actually post it. x__xgafv: string, V1 error format. Allowed values @@ -661,4 +664,37 @@

Method Details

}
+
+ processGitHubEnterpriseWebhook(parent, body=None, x__xgafv=None) +
ProcessGitHubEnterpriseWebhook is called by the external GitHub Enterprise instances for notifying events.
+
+Args:
+  parent: string, Required. Project and location where the webhook will be received. Format: `projects/*/locations/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # RPC request object accepted by the ProcessGitHubEnterpriseWebhook RPC method.
+  "body": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # Required. HTTP request body.
+    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+    "data": "A String", # The HTTP request/response body as raw binary.
+    "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.html b/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.html index 19d9f81e0c..9a2192908c 100644 --- a/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.html +++ b/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.html @@ -158,6 +158,9 @@

Method Details

"phraseHints": [ # A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [`speech_contexts`]() instead. If you specify both [`phrase_hints`]() and [`speech_contexts`](), Dialogflow will treat the [`phrase_hints`]() as a single additional [`SpeechContext`](). "A String", ], + "phraseSets": [ # A collection of phrase set resources to use for speech adaptation. + "A String", + ], "sampleRateHertz": 42, # Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "singleUtterance": True or False, # If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance. "speechContexts": [ # Context information to assist speech recognition. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. diff --git a/docs/dyn/dialogflow_v2.projects.agent.sessions.html b/docs/dyn/dialogflow_v2.projects.agent.sessions.html index 519ca8b64c..d0f7e3be96 100644 --- a/docs/dyn/dialogflow_v2.projects.agent.sessions.html +++ b/docs/dyn/dialogflow_v2.projects.agent.sessions.html @@ -158,6 +158,9 @@

Method Details

"phraseHints": [ # A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [`speech_contexts`]() instead. If you specify both [`phrase_hints`]() and [`speech_contexts`](), Dialogflow will treat the [`phrase_hints`]() as a single additional [`SpeechContext`](). "A String", ], + "phraseSets": [ # A collection of phrase set resources to use for speech adaptation. + "A String", + ], "sampleRateHertz": 42, # Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "singleUtterance": True or False, # If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance. "speechContexts": [ # Context information to assist speech recognition. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. diff --git a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html index a9c73dd37f..1608dc8b9a 100644 --- a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html @@ -190,6 +190,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -250,6 +251,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -326,6 +328,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -385,6 +390,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -445,6 +451,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -521,6 +528,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -605,6 +615,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -665,6 +676,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -741,6 +753,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -811,6 +826,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -871,6 +887,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -947,6 +964,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -1025,6 +1045,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -1085,6 +1106,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -1161,6 +1183,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -1221,6 +1246,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -1281,6 +1307,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -1357,6 +1384,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -1409,6 +1439,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. diff --git a/docs/dyn/dialogflow_v2.projects.conversations.html b/docs/dyn/dialogflow_v2.projects.conversations.html index b3783b1d5c..de04fdbbee 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.html @@ -167,7 +167,7 @@

Method Details

"startTime": "A String", # Output only. The time the conversation was started. } - conversationId: string, Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness. + conversationId: string, Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/dialogflow_v2.projects.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.conversations.participants.html index db49f4e466..24d5ade4c3 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.participants.html @@ -755,6 +755,9 @@

Method Details

"generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. { # Snippet Source for a Generative Prediction. + "metadata": { # Metadata of the document. + "a_key": "", # Properties of the object. + }, "text": "A String", # Text taken from that URI. "title": "A String", # Title of the document. "uri": "A String", # URI the data is sourced from. @@ -838,6 +841,9 @@

Method Details

"generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. { # Snippet Source for a Generative Prediction. + "metadata": { # Metadata of the document. + "a_key": "", # Properties of the object. + }, "text": "A String", # Text taken from that URI. "title": "A String", # Title of the document. "uri": "A String", # URI the data is sourced from. diff --git a/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html index 9cb090992b..d9cbf143b0 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html @@ -225,6 +225,9 @@

Method Details

"generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. { # Snippet Source for a Generative Prediction. + "metadata": { # Metadata of the document. + "a_key": "", # Properties of the object. + }, "text": "A String", # Text taken from that URI. "title": "A String", # Title of the document. "uri": "A String", # URI the data is sourced from. diff --git a/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html b/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html index 94d7b77a65..e563c48e64 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html @@ -101,12 +101,55 @@

Method Details

{ # The request message for Conversations.SearchKnowledge. "conversation": "A String", # Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. "conversationProfile": "A String", # Required. The conversation profile used to configure the search. Format: `projects//locations//conversationProfiles/`. + "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ``` + "a_key": "", # Properties of the object. + }, + "exactSearch": True or False, # Optional. Whether to search the query exactly without query rewrite. "latestMessage": "A String", # Optional. The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`. "parent": "A String", # Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. "query": { # Auxiliary proto messages. Represents the natural language text to be processed. # Required. The natural language text query for knowledge search. "languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. }, + "querySource": "A String", # Optional. The source of the query in the request. + "searchConfig": { # Configuration specific to search queries with data stores. # Optional. Configuration specific to search queries with data stores. + "boostSpecs": [ # Optional. Boost specifications for data stores. + { # Boost specifications for data stores. + "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store} + "A String", + ], + "spec": [ # Optional. A list of boosting specifications. + { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec + "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. + { # Boost applies to documents which match a condition. + "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable). + "attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, + "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) + }, + ], + }, + ], + }, + ], + "filterSpecs": [ # Optional. Filter specification for data store queries. + { # Filter specification for data store queries. + "dataStores": [ # Optional. The data store where the filter configuration is applied. Full resource name of data store, such as projects/{project}/locations/{location}/collections/{collectionId}/ dataStores/{dataStoreId}. + "A String", + ], + "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax + }, + ], + }, "sessionId": "A String", # Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. } @@ -125,6 +168,9 @@

Method Details

"answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/` "answerSources": [ # All sources used to generate the answer. { # The sources of the answers. + "metadata": { # Metadata associated with the article. + "a_key": "", # Properties of the object. + }, "snippet": "A String", # The relevant snippet of the article. "title": "A String", # The title of the article. "uri": "A String", # The URI of the article. diff --git a/docs/dyn/dialogflow_v2.projects.generators.html b/docs/dyn/dialogflow_v2.projects.generators.html index 6b077fe3ba..58723d760a 100644 --- a/docs/dyn/dialogflow_v2.projects.generators.html +++ b/docs/dyn/dialogflow_v2.projects.generators.html @@ -162,7 +162,7 @@

Method Details

"updateTime": "A String", # Output only. Update time of this generator. } - generatorId: string, Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness. + generatorId: string, Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/dialogflow_v2.projects.locations.agent.environments.users.sessions.html b/docs/dyn/dialogflow_v2.projects.locations.agent.environments.users.sessions.html index 9b0f8ea385..cee03c8a48 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.agent.environments.users.sessions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.agent.environments.users.sessions.html @@ -158,6 +158,9 @@

Method Details

"phraseHints": [ # A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [`speech_contexts`]() instead. If you specify both [`phrase_hints`]() and [`speech_contexts`](), Dialogflow will treat the [`phrase_hints`]() as a single additional [`SpeechContext`](). "A String", ], + "phraseSets": [ # A collection of phrase set resources to use for speech adaptation. + "A String", + ], "sampleRateHertz": 42, # Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "singleUtterance": True or False, # If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance. "speechContexts": [ # Context information to assist speech recognition. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. diff --git a/docs/dyn/dialogflow_v2.projects.locations.agent.sessions.html b/docs/dyn/dialogflow_v2.projects.locations.agent.sessions.html index 2d2c7ec40b..23442d36a1 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.agent.sessions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.agent.sessions.html @@ -158,6 +158,9 @@

Method Details

"phraseHints": [ # A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [`speech_contexts`]() instead. If you specify both [`phrase_hints`]() and [`speech_contexts`](), Dialogflow will treat the [`phrase_hints`]() as a single additional [`SpeechContext`](). "A String", ], + "phraseSets": [ # A collection of phrase set resources to use for speech adaptation. + "A String", + ], "sampleRateHertz": 42, # Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "singleUtterance": True or False, # If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance. "speechContexts": [ # Context information to assist speech recognition. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html index 35e2733c0b..13b71c5a3a 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html @@ -190,6 +190,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -250,6 +251,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -326,6 +328,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -385,6 +390,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -445,6 +451,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -521,6 +528,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -605,6 +615,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -665,6 +676,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -741,6 +753,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -811,6 +826,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -871,6 +887,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -947,6 +964,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -1025,6 +1045,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -1085,6 +1106,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -1161,6 +1183,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -1221,6 +1246,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -1281,6 +1307,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -1357,6 +1384,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -1409,6 +1439,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.html index 7b7f4d2296..c337842429 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.html @@ -167,7 +167,7 @@

Method Details

"startTime": "A String", # Output only. The time the conversation was started. } - conversationId: string, Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness. + conversationId: string, Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html index 64587a4e13..ed86b428c5 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html @@ -755,6 +755,9 @@

Method Details

"generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. { # Snippet Source for a Generative Prediction. + "metadata": { # Metadata of the document. + "a_key": "", # Properties of the object. + }, "text": "A String", # Text taken from that URI. "title": "A String", # Title of the document. "uri": "A String", # URI the data is sourced from. @@ -838,6 +841,9 @@

Method Details

"generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. { # Snippet Source for a Generative Prediction. + "metadata": { # Metadata of the document. + "a_key": "", # Properties of the object. + }, "text": "A String", # Text taken from that URI. "title": "A String", # Title of the document. "uri": "A String", # URI the data is sourced from. diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html index 7fa0f69b2a..fe3058ada3 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html @@ -225,6 +225,9 @@

Method Details

"generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. { # Snippet Source for a Generative Prediction. + "metadata": { # Metadata of the document. + "a_key": "", # Properties of the object. + }, "text": "A String", # Text taken from that URI. "title": "A String", # Title of the document. "uri": "A String", # URI the data is sourced from. diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html index 8a67719a91..36ab718c3b 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html @@ -101,12 +101,55 @@

Method Details

{ # The request message for Conversations.SearchKnowledge. "conversation": "A String", # Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. "conversationProfile": "A String", # Required. The conversation profile used to configure the search. Format: `projects//locations//conversationProfiles/`. + "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ``` + "a_key": "", # Properties of the object. + }, + "exactSearch": True or False, # Optional. Whether to search the query exactly without query rewrite. "latestMessage": "A String", # Optional. The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`. "parent": "A String", # Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. "query": { # Auxiliary proto messages. Represents the natural language text to be processed. # Required. The natural language text query for knowledge search. "languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. }, + "querySource": "A String", # Optional. The source of the query in the request. + "searchConfig": { # Configuration specific to search queries with data stores. # Optional. Configuration specific to search queries with data stores. + "boostSpecs": [ # Optional. Boost specifications for data stores. + { # Boost specifications for data stores. + "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store} + "A String", + ], + "spec": [ # Optional. A list of boosting specifications. + { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec + "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. + { # Boost applies to documents which match a condition. + "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable). + "attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, + "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) + }, + ], + }, + ], + }, + ], + "filterSpecs": [ # Optional. Filter specification for data store queries. + { # Filter specification for data store queries. + "dataStores": [ # Optional. The data store where the filter configuration is applied. Full resource name of data store, such as projects/{project}/locations/{location}/collections/{collectionId}/ dataStores/{dataStoreId}. + "A String", + ], + "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax + }, + ], + }, "sessionId": "A String", # Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. } @@ -125,6 +168,9 @@

Method Details

"answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/` "answerSources": [ # All sources used to generate the answer. { # The sources of the answers. + "metadata": { # Metadata associated with the article. + "a_key": "", # Properties of the object. + }, "snippet": "A String", # The relevant snippet of the article. "title": "A String", # The title of the article. "uri": "A String", # The URI of the article. diff --git a/docs/dyn/dialogflow_v2.projects.locations.generators.html b/docs/dyn/dialogflow_v2.projects.locations.generators.html index d38271e78e..bbefcd87a4 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.generators.html +++ b/docs/dyn/dialogflow_v2.projects.locations.generators.html @@ -171,7 +171,7 @@

Method Details

"updateTime": "A String", # Output only. Update time of this generator. } - generatorId: string, Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness. + generatorId: string, Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -265,7 +265,7 @@

Method Details

Retrieves a generator.
 
 Args:
-  name: string, Required. The generator resource name to retrieve. Format: `projects//locations/`/generators/` (required)
+  name: string, Required. The generator resource name to retrieve. Format: `projects//locations//generators/` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html
index 93ed2e8771..a59e9a668a 100644
--- a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html
+++ b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html
@@ -130,6 +130,7 @@ 

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -190,6 +191,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -266,6 +268,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -351,12 +356,55 @@

Method Details

{ # The request message for Conversations.SearchKnowledge. "conversation": "A String", # Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. "conversationProfile": "A String", # Required. The conversation profile used to configure the search. Format: `projects//locations//conversationProfiles/`. + "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ``` + "a_key": "", # Properties of the object. + }, + "exactSearch": True or False, # Optional. Whether to search the query exactly without query rewrite. "latestMessage": "A String", # Optional. The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`. "parent": "A String", # Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. "query": { # Auxiliary proto messages. Represents the natural language text to be processed. # Required. The natural language text query for knowledge search. "languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. }, + "querySource": "A String", # Optional. The source of the query in the request. + "searchConfig": { # Configuration specific to search queries with data stores. # Optional. Configuration specific to search queries with data stores. + "boostSpecs": [ # Optional. Boost specifications for data stores. + { # Boost specifications for data stores. + "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store} + "A String", + ], + "spec": [ # Optional. A list of boosting specifications. + { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec + "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. + { # Boost applies to documents which match a condition. + "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable). + "attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, + "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) + }, + ], + }, + ], + }, + ], + "filterSpecs": [ # Optional. Filter specification for data store queries. + { # Filter specification for data store queries. + "dataStores": [ # Optional. The data store where the filter configuration is applied. Full resource name of data store, such as projects/{project}/locations/{location}/collections/{collectionId}/ dataStores/{dataStoreId}. + "A String", + ], + "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax + }, + ], + }, "sessionId": "A String", # Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. } @@ -375,6 +423,9 @@

Method Details

"answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/` "answerSources": [ # All sources used to generate the answer. { # The sources of the answers. + "metadata": { # Metadata associated with the article. + "a_key": "", # Properties of the object. + }, "snippet": "A String", # The relevant snippet of the article. "title": "A String", # The title of the article. "uri": "A String", # The URI of the article. diff --git a/docs/dyn/dialogflow_v2.projects.suggestions.html b/docs/dyn/dialogflow_v2.projects.suggestions.html index 9c690273b4..572af4cc1b 100644 --- a/docs/dyn/dialogflow_v2.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.suggestions.html @@ -130,6 +130,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -190,6 +191,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST. "agent": "A String", # Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # Optional. The Dialogflow assist configuration for human agent. @@ -266,6 +268,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -351,12 +356,55 @@

Method Details

{ # The request message for Conversations.SearchKnowledge. "conversation": "A String", # Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. "conversationProfile": "A String", # Required. The conversation profile used to configure the search. Format: `projects//locations//conversationProfiles/`. + "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ``` + "a_key": "", # Properties of the object. + }, + "exactSearch": True or False, # Optional. Whether to search the query exactly without query rewrite. "latestMessage": "A String", # Optional. The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`. "parent": "A String", # Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. "query": { # Auxiliary proto messages. Represents the natural language text to be processed. # Required. The natural language text query for knowledge search. "languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. }, + "querySource": "A String", # Optional. The source of the query in the request. + "searchConfig": { # Configuration specific to search queries with data stores. # Optional. Configuration specific to search queries with data stores. + "boostSpecs": [ # Optional. Boost specifications for data stores. + { # Boost specifications for data stores. + "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store} + "A String", + ], + "spec": [ # Optional. A list of boosting specifications. + { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec + "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. + { # Boost applies to documents which match a condition. + "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable). + "attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, + "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) + }, + ], + }, + ], + }, + ], + "filterSpecs": [ # Optional. Filter specification for data store queries. + { # Filter specification for data store queries. + "dataStores": [ # Optional. The data store where the filter configuration is applied. Full resource name of data store, such as projects/{project}/locations/{location}/collections/{collectionId}/ dataStores/{dataStoreId}. + "A String", + ], + "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax + }, + ], + }, "sessionId": "A String", # Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. } @@ -375,6 +423,9 @@

Method Details

"answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/` "answerSources": [ # All sources used to generate the answer. { # The sources of the answers. + "metadata": { # Metadata associated with the article. + "a_key": "", # Properties of the object. + }, "snippet": "A String", # The relevant snippet of the article. "title": "A String", # The title of the article. "uri": "A String", # The URI of the article. diff --git a/docs/dyn/dialogflow_v2beta1.projects.agent.environments.users.sessions.html b/docs/dyn/dialogflow_v2beta1.projects.agent.environments.users.sessions.html index 3630c61330..2bba382f41 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.agent.environments.users.sessions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.agent.environments.users.sessions.html @@ -163,6 +163,9 @@

Method Details

"phraseHints": [ # A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [`speech_contexts`]() instead. If you specify both [`phrase_hints`]() and [`speech_contexts`](), Dialogflow will treat the [`phrase_hints`]() as a single additional [`SpeechContext`](). "A String", ], + "phraseSets": [ # A collection of phrase set resources to use for speech adaptation. + "A String", + ], "sampleRateHertz": 42, # Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "singleUtterance": True or False, # If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance. "speechContexts": [ # Context information to assist speech recognition. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. diff --git a/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html b/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html index b4eec144ec..ce8f271315 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html @@ -163,6 +163,9 @@

Method Details

"phraseHints": [ # A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [`speech_contexts`]() instead. If you specify both [`phrase_hints`]() and [`speech_contexts`](), Dialogflow will treat the [`phrase_hints`]() as a single additional [`SpeechContext`](). "A String", ], + "phraseSets": [ # A collection of phrase set resources to use for speech adaptation. + "A String", + ], "sampleRateHertz": 42, # Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "singleUtterance": True or False, # If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance. "speechContexts": [ # Context information to assist speech recognition. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html index 1d8d26f543..ca17e9f7b2 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html @@ -190,6 +190,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -250,6 +251,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -326,6 +328,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -385,6 +390,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -445,6 +451,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -521,6 +528,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -605,6 +615,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -665,6 +676,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -741,6 +753,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -811,6 +826,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -871,6 +887,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -947,6 +964,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -1025,6 +1045,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -1085,6 +1106,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -1161,6 +1183,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -1221,6 +1246,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -1281,6 +1307,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -1357,6 +1384,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -1409,6 +1439,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.html index 81051fd4fc..eaf435df3b 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.html @@ -167,7 +167,7 @@

Method Details

"startTime": "A String", # Output only. The time the conversation was started. } - conversationId: string, Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness. + conversationId: string, Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html index 17f8a03555..cc7c805613 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html @@ -135,6 +135,9 @@

Method Details

"phraseHints": [ # A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [`speech_contexts`]() instead. If you specify both [`phrase_hints`]() and [`speech_contexts`](), Dialogflow will treat the [`phrase_hints`]() as a single additional [`SpeechContext`](). "A String", ], + "phraseSets": [ # A collection of phrase set resources to use for speech adaptation. + "A String", + ], "sampleRateHertz": 42, # Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "singleUtterance": True or False, # If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance. "speechContexts": [ # Context information to assist speech recognition. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. @@ -3099,6 +3102,9 @@

Method Details

"generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. { # Snippet Source for a Generative Prediction. + "metadata": { # Metadata of the document. + "a_key": "", # Properties of the object. + }, "text": "A String", # Text taken from that URI. "title": "A String", # Title of the document. "uri": "A String", # URI the data is sourced from. @@ -4545,6 +4551,9 @@

Method Details

"generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. { # Snippet Source for a Generative Prediction. + "metadata": { # Metadata of the document. + "a_key": "", # Properties of the object. + }, "text": "A String", # Text taken from that URI. "title": "A String", # Title of the document. "uri": "A String", # URI the data is sourced from. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html index 101b962eba..e4c36c4413 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html @@ -359,6 +359,9 @@

Method Details

"generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. { # Snippet Source for a Generative Prediction. + "metadata": { # Metadata of the document. + "a_key": "", # Properties of the object. + }, "text": "A String", # Text taken from that URI. "title": "A String", # Title of the document. "uri": "A String", # URI the data is sourced from. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html index 69e50f4416..de51e11693 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html @@ -101,12 +101,55 @@

Method Details

{ # The request message for Conversations.SearchKnowledge. "conversation": "A String", # Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. "conversationProfile": "A String", # Required. The conversation profile used to configure the search. Format: `projects//locations//conversationProfiles/`. + "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ``` + "a_key": "", # Properties of the object. + }, + "exactSearch": True or False, # Optional. Whether to search the query exactly without query rewrite. "latestMessage": "A String", # Optional. The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`. "parent": "A String", # Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. "query": { # Represents the natural language text to be processed. # Required. The natural language text query for knowledge search. "languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. }, + "querySource": "A String", # Optional. The source of the query in the request. + "searchConfig": { # Configuration specific to search queries with data stores. # Optional. Configuration specific to search queries with data stores. + "boostSpecs": [ # Optional. Boost specifications for data stores. + { # Boost specifications for data stores. + "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store} + "A String", + ], + "spec": [ # Optional. A list of boosting specifications. + { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec + "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. + { # Boost applies to documents which match a condition. + "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable). + "attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, + "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) + }, + ], + }, + ], + }, + ], + "filterSpecs": [ # Optional. Filter specification for data store queries. + { # Filter specification for data store queries. + "dataStores": [ # Optional. The data store where the filter configuration is applied. Full resource name of data store, such as projects/{project}/locations/{location}/collections/{collectionId}/ dataStores/{dataStoreId}. + "A String", + ], + "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax + }, + ], + }, "sessionId": "A String", # Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. } @@ -125,6 +168,9 @@

Method Details

"answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/` "answerSources": [ # All sources used to generate the answer. { # The sources of the answers. + "metadata": { # Metadata associated with the article. + "a_key": "", # Properties of the object. + }, "snippet": "A String", # The relevant snippet of the article. "title": "A String", # The title of the article. "uri": "A String", # The URI of the article. diff --git a/docs/dyn/dialogflow_v2beta1.projects.generators.html b/docs/dyn/dialogflow_v2beta1.projects.generators.html index a8e02a245a..242cc05524 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.generators.html +++ b/docs/dyn/dialogflow_v2beta1.projects.generators.html @@ -162,7 +162,7 @@

Method Details

"updateTime": "A String", # Output only. Update time of this generator. } - generatorId: string, Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness. + generatorId: string, Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.users.sessions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.users.sessions.html index 96597bba69..5ec0e03fda 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.users.sessions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.users.sessions.html @@ -163,6 +163,9 @@

Method Details

"phraseHints": [ # A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [`speech_contexts`]() instead. If you specify both [`phrase_hints`]() and [`speech_contexts`](), Dialogflow will treat the [`phrase_hints`]() as a single additional [`SpeechContext`](). "A String", ], + "phraseSets": [ # A collection of phrase set resources to use for speech adaptation. + "A String", + ], "sampleRateHertz": 42, # Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "singleUtterance": True or False, # If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance. "speechContexts": [ # Context information to assist speech recognition. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.sessions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.sessions.html index f07baee347..54977eed17 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.sessions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.sessions.html @@ -163,6 +163,9 @@

Method Details

"phraseHints": [ # A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [`speech_contexts`]() instead. If you specify both [`phrase_hints`]() and [`speech_contexts`](), Dialogflow will treat the [`phrase_hints`]() as a single additional [`SpeechContext`](). "A String", ], + "phraseSets": [ # A collection of phrase set resources to use for speech adaptation. + "A String", + ], "sampleRateHertz": 42, # Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "singleUtterance": True or False, # If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance. "speechContexts": [ # Context information to assist speech recognition. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html index c269ae6b0f..762d9546f4 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html @@ -190,6 +190,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -250,6 +251,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -326,6 +328,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -385,6 +390,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -445,6 +451,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -521,6 +528,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -605,6 +615,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -665,6 +676,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -741,6 +753,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -811,6 +826,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -871,6 +887,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -947,6 +964,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -1025,6 +1045,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -1085,6 +1106,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -1161,6 +1183,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -1221,6 +1246,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -1281,6 +1307,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -1357,6 +1384,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -1409,6 +1439,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html index beb11b0fec..7d393bbf73 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html @@ -167,7 +167,7 @@

Method Details

"startTime": "A String", # Output only. The time the conversation was started. } - conversationId: string, Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness. + conversationId: string, Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html index 511c4178fa..dd5a92dcdb 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html @@ -135,6 +135,9 @@

Method Details

"phraseHints": [ # A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [`speech_contexts`]() instead. If you specify both [`phrase_hints`]() and [`speech_contexts`](), Dialogflow will treat the [`phrase_hints`]() as a single additional [`SpeechContext`](). "A String", ], + "phraseSets": [ # A collection of phrase set resources to use for speech adaptation. + "A String", + ], "sampleRateHertz": 42, # Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "singleUtterance": True or False, # If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance. "speechContexts": [ # Context information to assist speech recognition. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. @@ -3099,6 +3102,9 @@

Method Details

"generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. { # Snippet Source for a Generative Prediction. + "metadata": { # Metadata of the document. + "a_key": "", # Properties of the object. + }, "text": "A String", # Text taken from that URI. "title": "A String", # Title of the document. "uri": "A String", # URI the data is sourced from. @@ -4545,6 +4551,9 @@

Method Details

"generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. { # Snippet Source for a Generative Prediction. + "metadata": { # Metadata of the document. + "a_key": "", # Properties of the object. + }, "text": "A String", # Text taken from that URI. "title": "A String", # Title of the document. "uri": "A String", # URI the data is sourced from. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html index 6d2200c454..cfac036962 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html @@ -224,6 +224,9 @@

Method Details

"generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. { # Snippet Source for a Generative Prediction. + "metadata": { # Metadata of the document. + "a_key": "", # Properties of the object. + }, "text": "A String", # Text taken from that URI. "title": "A String", # Title of the document. "uri": "A String", # URI the data is sourced from. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html index fd5a6e5bbf..f5b5bf2dc7 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html @@ -101,12 +101,55 @@

Method Details

{ # The request message for Conversations.SearchKnowledge. "conversation": "A String", # Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. "conversationProfile": "A String", # Required. The conversation profile used to configure the search. Format: `projects//locations//conversationProfiles/`. + "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ``` + "a_key": "", # Properties of the object. + }, + "exactSearch": True or False, # Optional. Whether to search the query exactly without query rewrite. "latestMessage": "A String", # Optional. The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`. "parent": "A String", # Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. "query": { # Represents the natural language text to be processed. # Required. The natural language text query for knowledge search. "languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. }, + "querySource": "A String", # Optional. The source of the query in the request. + "searchConfig": { # Configuration specific to search queries with data stores. # Optional. Configuration specific to search queries with data stores. + "boostSpecs": [ # Optional. Boost specifications for data stores. + { # Boost specifications for data stores. + "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store} + "A String", + ], + "spec": [ # Optional. A list of boosting specifications. + { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec + "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. + { # Boost applies to documents which match a condition. + "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable). + "attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, + "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) + }, + ], + }, + ], + }, + ], + "filterSpecs": [ # Optional. Filter specification for data store queries. + { # Filter specification for data store queries. + "dataStores": [ # Optional. The data store where the filter configuration is applied. Full resource name of data store, such as projects/{project}/locations/{location}/collections/{collectionId}/ dataStores/{dataStoreId}. + "A String", + ], + "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax + }, + ], + }, "sessionId": "A String", # Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. } @@ -125,6 +168,9 @@

Method Details

"answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/` "answerSources": [ # All sources used to generate the answer. { # The sources of the answers. + "metadata": { # Metadata associated with the article. + "a_key": "", # Properties of the object. + }, "snippet": "A String", # The relevant snippet of the article. "title": "A String", # The title of the article. "uri": "A String", # The URI of the article. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.generators.html b/docs/dyn/dialogflow_v2beta1.projects.locations.generators.html index d94baf7cfc..7a2752a7e6 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.generators.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.generators.html @@ -171,7 +171,7 @@

Method Details

"updateTime": "A String", # Output only. Update time of this generator. } - generatorId: string, Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness. + generatorId: string, Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html index f63805e25c..0e5482544d 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html @@ -130,6 +130,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -190,6 +191,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -266,6 +268,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -383,12 +388,55 @@

Method Details

{ # The request message for Conversations.SearchKnowledge. "conversation": "A String", # Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. "conversationProfile": "A String", # Required. The conversation profile used to configure the search. Format: `projects//locations//conversationProfiles/`. + "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ``` + "a_key": "", # Properties of the object. + }, + "exactSearch": True or False, # Optional. Whether to search the query exactly without query rewrite. "latestMessage": "A String", # Optional. The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`. "parent": "A String", # Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. "query": { # Represents the natural language text to be processed. # Required. The natural language text query for knowledge search. "languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. }, + "querySource": "A String", # Optional. The source of the query in the request. + "searchConfig": { # Configuration specific to search queries with data stores. # Optional. Configuration specific to search queries with data stores. + "boostSpecs": [ # Optional. Boost specifications for data stores. + { # Boost specifications for data stores. + "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store} + "A String", + ], + "spec": [ # Optional. A list of boosting specifications. + { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec + "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. + { # Boost applies to documents which match a condition. + "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable). + "attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, + "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) + }, + ], + }, + ], + }, + ], + "filterSpecs": [ # Optional. Filter specification for data store queries. + { # Filter specification for data store queries. + "dataStores": [ # Optional. The data store where the filter configuration is applied. Full resource name of data store, such as projects/{project}/locations/{location}/collections/{collectionId}/ dataStores/{dataStoreId}. + "A String", + ], + "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax + }, + ], + }, "sessionId": "A String", # Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. } @@ -407,6 +455,9 @@

Method Details

"answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/` "answerSources": [ # All sources used to generate the answer. { # The sources of the answers. + "metadata": { # Metadata associated with the article. + "a_key": "", # Properties of the object. + }, "snippet": "A String", # The relevant snippet of the article. "title": "A String", # The title of the article. "uri": "A String", # The URI of the article. diff --git a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html index 10db99ed98..52cbb50f51 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html @@ -130,6 +130,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -190,6 +191,7 @@

Method Details

"dropIvrMessages": True or False, # If set to true, all messages from ivr stage are dropped. "dropVirtualAgentMessages": True or False, # If set to true, all messages from virtual agent are dropped. }, + "contextSize": 42, # Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. "dialogflowQuerySource": { # Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. # Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. "agent": "A String", # Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project. "humanAgentSideConfig": { # The configuration used for human agent side Dialogflow assist suggestion. # The Dialogflow assist configuration for human agent. @@ -266,6 +268,9 @@

Method Details

"enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "phraseSets": [ # List of names of Cloud Speech phrase sets that are used for transcription. + "A String", + ], "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. @@ -383,12 +388,55 @@

Method Details

{ # The request message for Conversations.SearchKnowledge. "conversation": "A String", # Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. "conversationProfile": "A String", # Required. The conversation profile used to configure the search. Format: `projects//locations//conversationProfiles/`. + "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ``` + "a_key": "", # Properties of the object. + }, + "exactSearch": True or False, # Optional. Whether to search the query exactly without query rewrite. "latestMessage": "A String", # Optional. The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`. "parent": "A String", # Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. "query": { # Represents the natural language text to be processed. # Required. The natural language text query for knowledge search. "languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. }, + "querySource": "A String", # Optional. The source of the query in the request. + "searchConfig": { # Configuration specific to search queries with data stores. # Optional. Configuration specific to search queries with data stores. + "boostSpecs": [ # Optional. Boost specifications for data stores. + { # Boost specifications for data stores. + "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store} + "A String", + ], + "spec": [ # Optional. A list of boosting specifications. + { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec + "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. + { # Boost applies to documents which match a condition. + "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable). + "attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, + "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) + }, + ], + }, + ], + }, + ], + "filterSpecs": [ # Optional. Filter specification for data store queries. + { # Filter specification for data store queries. + "dataStores": [ # Optional. The data store where the filter configuration is applied. Full resource name of data store, such as projects/{project}/locations/{location}/collections/{collectionId}/ dataStores/{dataStoreId}. + "A String", + ], + "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax + }, + ], + }, "sessionId": "A String", # Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. } @@ -407,6 +455,9 @@

Method Details

"answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/` "answerSources": [ # All sources used to generate the answer. { # The sources of the answers. + "metadata": { # Metadata associated with the article. + "a_key": "", # Properties of the object. + }, "snippet": "A String", # The relevant snippet of the article. "title": "A String", # The title of the article. "uri": "A String", # The URI of the article. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.html index 08fbbad621..d7bbef7423 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.html @@ -113,7 +113,7 @@

Method Details

"dataIngestionSource": "A String", # The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming. "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed. "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document. - "fhirResource": "A String", # Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} + "fhirResource": "A String", # Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} "uri": "A String", # If match by URI, the URI of the Document. }, "state": "A String", # The state of the document. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.controls.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.controls.html index bd6b3dd381..7a4c339869 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.controls.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.controls.html @@ -127,7 +127,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -181,7 +182,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -259,7 +261,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -324,7 +327,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -396,7 +400,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -450,7 +455,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.customModels.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.customModels.html index 290b55aed1..f742610c2a 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.customModels.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.customModels.html @@ -103,7 +103,7 @@

Method Details

{ # Response message for SearchTuningService.ListCustomModels method. "models": [ # List of custom tuning models. { # Metadata that describes a custom tuned model. - "createTime": "A String", # Timestamp the Model was created at. + "createTime": "A String", # Deprecated: Timestamp the Model was created at. "displayName": "A String", # The display name of the model. "errorMessage": "A String", # Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`. "metrics": { # The metrics of the trained model. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html index ab89fc62f0..c4737cffda 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html @@ -146,7 +146,7 @@

Instance Methods

completeQuery(dataStore, includeTailSuggestions=None, query=None, queryModel=None, userPseudoId=None, x__xgafv=None)

Completes the specified user input with keyword suggestions.

- create(parent, body=None, createAdvancedSiteSearch=None, dataStoreId=None, skipDefaultSchemaCreation=None, x__xgafv=None)

+ create(parent, body=None, cmekConfigName=None, createAdvancedSiteSearch=None, dataStoreId=None, disableCmek=None, skipDefaultSchemaCreation=None, x__xgafv=None)

Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.

delete(name, x__xgafv=None)

@@ -207,7 +207,7 @@

Method Details

- create(parent, body=None, createAdvancedSiteSearch=None, dataStoreId=None, skipDefaultSchemaCreation=None, x__xgafv=None) + create(parent, body=None, cmekConfigName=None, createAdvancedSiteSearch=None, dataStoreId=None, disableCmek=None, skipDefaultSchemaCreation=None, x__xgafv=None)
Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
 
 Args:
@@ -216,6 +216,8 @@ 

Method Details

The object takes the form of: { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -224,6 +226,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -264,6 +274,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "servingConfigDataStore": { # Stores information regarding the serving configurations at DataStore level. # Optional. Stores serving config at DataStore level. "disabledForServing": True or False, # If set true, the DataStore will not be available for serving search requests. @@ -286,8 +297,10 @@

Method Details

}, } + cmekConfigName: string, Resource name of the CmekConfig to use for protecting this DataStore. createAdvancedSiteSearch: boolean, A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. dataStoreId: string, Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. 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. + disableCmek: boolean, DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. skipDefaultSchemaCreation: boolean, A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. x__xgafv: string, V1 error format. Allowed values @@ -368,6 +381,8 @@

Method Details

An object of the form: { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -376,6 +391,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -416,6 +439,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "servingConfigDataStore": { # Stores information regarding the serving configurations at DataStore level. # Optional. Stores serving config at DataStore level. "disabledForServing": True or False, # If set true, the DataStore will not be available for serving search requests. @@ -478,6 +502,8 @@

Method Details

{ # Response message for DataStoreService.ListDataStores method. "dataStores": [ # All the customer's DataStores. { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -486,6 +512,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -526,6 +560,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "servingConfigDataStore": { # Stores information regarding the serving configurations at DataStore level. # Optional. Stores serving config at DataStore level. "disabledForServing": True or False, # If set true, the DataStore will not be available for serving search requests. @@ -576,6 +611,8 @@

Method Details

The object takes the form of: { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -584,6 +621,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -624,6 +669,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "servingConfigDataStore": { # Stores information regarding the serving configurations at DataStore level. # Optional. Stores serving config at DataStore level. "disabledForServing": True or False, # If set true, the DataStore will not be available for serving search requests. @@ -656,6 +702,8 @@

Method Details

An object of the form: { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -664,6 +712,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -704,6 +760,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "servingConfigDataStore": { # Stores information regarding the serving configurations at DataStore level. # Optional. Stores serving config at DataStore level. "disabledForServing": True or False, # If set true, the DataStore will not be available for serving search requests. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html index 5c6718931f..1a587a302b 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -313,7 +313,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -621,6 +621,7 @@

Method Details

}, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html index ae79777369..ca84b4cc34 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html @@ -191,7 +191,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.controls.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.controls.html index 9d1072e7ae..b920b0378d 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.controls.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.controls.html @@ -127,7 +127,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -181,7 +182,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -259,7 +261,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -324,7 +327,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -396,7 +400,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -450,7 +455,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html index 3a7aff15a3..832484c3b6 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -313,7 +313,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -621,6 +621,7 @@

Method Details

}, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html index d264e64296..6b30efff1f 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html @@ -191,7 +191,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.html index c3fe5e3551..84f1ad5327 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.html @@ -113,7 +113,7 @@

Method Details

"dataIngestionSource": "A String", # The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming. "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed. "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document. - "fhirResource": "A String", # Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} + "fhirResource": "A String", # Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} "uri": "A String", # If match by URI, the URI of the Document. }, "state": "A String", # The state of the document. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.controls.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.controls.html index 3eee9693b1..1d73149af5 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.controls.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.controls.html @@ -127,7 +127,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -181,7 +182,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -259,7 +261,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -324,7 +327,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -396,7 +400,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -450,7 +455,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html index cc368911f8..819204cb95 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html @@ -141,7 +141,7 @@

Instance Methods

completeQuery(dataStore, includeTailSuggestions=None, query=None, queryModel=None, userPseudoId=None, x__xgafv=None)

Completes the specified user input with keyword suggestions.

- create(parent, body=None, createAdvancedSiteSearch=None, dataStoreId=None, skipDefaultSchemaCreation=None, x__xgafv=None)

+ create(parent, body=None, cmekConfigName=None, createAdvancedSiteSearch=None, dataStoreId=None, disableCmek=None, skipDefaultSchemaCreation=None, x__xgafv=None)

Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.

delete(name, x__xgafv=None)

@@ -199,7 +199,7 @@

Method Details

- create(parent, body=None, createAdvancedSiteSearch=None, dataStoreId=None, skipDefaultSchemaCreation=None, x__xgafv=None) + create(parent, body=None, cmekConfigName=None, createAdvancedSiteSearch=None, dataStoreId=None, disableCmek=None, skipDefaultSchemaCreation=None, x__xgafv=None)
Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
 
 Args:
@@ -208,6 +208,8 @@ 

Method Details

The object takes the form of: { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -216,6 +218,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -256,6 +266,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "servingConfigDataStore": { # Stores information regarding the serving configurations at DataStore level. # Optional. Stores serving config at DataStore level. "disabledForServing": True or False, # If set true, the DataStore will not be available for serving search requests. @@ -278,8 +289,10 @@

Method Details

}, } + cmekConfigName: string, Resource name of the CmekConfig to use for protecting this DataStore. createAdvancedSiteSearch: boolean, A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. dataStoreId: string, Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. 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. + disableCmek: boolean, DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. skipDefaultSchemaCreation: boolean, A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. x__xgafv: string, V1 error format. Allowed values @@ -360,6 +373,8 @@

Method Details

An object of the form: { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -368,6 +383,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -408,6 +431,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "servingConfigDataStore": { # Stores information regarding the serving configurations at DataStore level. # Optional. Stores serving config at DataStore level. "disabledForServing": True or False, # If set true, the DataStore will not be available for serving search requests. @@ -470,6 +494,8 @@

Method Details

{ # Response message for DataStoreService.ListDataStores method. "dataStores": [ # All the customer's DataStores. { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -478,6 +504,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -518,6 +552,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "servingConfigDataStore": { # Stores information regarding the serving configurations at DataStore level. # Optional. Stores serving config at DataStore level. "disabledForServing": True or False, # If set true, the DataStore will not be available for serving search requests. @@ -568,6 +603,8 @@

Method Details

The object takes the form of: { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -576,6 +613,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -616,6 +661,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "servingConfigDataStore": { # Stores information regarding the serving configurations at DataStore level. # Optional. Stores serving config at DataStore level. "disabledForServing": True or False, # If set true, the DataStore will not be available for serving search requests. @@ -648,6 +694,8 @@

Method Details

An object of the form: { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -656,6 +704,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -696,6 +752,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "servingConfigDataStore": { # Stores information regarding the serving configurations at DataStore level. # Optional. Stores serving config at DataStore level. "disabledForServing": True or False, # If set true, the DataStore will not be available for serving search requests. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index 915bad7e61..f4a296e717 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -313,7 +313,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -621,6 +621,7 @@

Method Details

}, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html index 03932e9b8d..99c503f72e 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html @@ -191,7 +191,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.groundingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.groundingConfigs.html index 5e34ff921b..569d05c46e 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.groundingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.groundingConfigs.html @@ -91,7 +91,7 @@

Method Details

The object takes the form of: { # Request message for GroundedGenerationService.CheckGrounding method. - "answerCandidate": "A String", # Answer candidate to check. Can have a maximum length of 1024 characters. + "answerCandidate": "A String", # Answer candidate to check. It can have a maximum length of 4096 tokens. "facts": [ # List of facts for the grounding check. We support up to 200 facts. { # Grounding Fact. "attributes": { # Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on. @@ -118,13 +118,9 @@

Method Details

{ # Response message for the GroundedGenerationService.CheckGrounding method. "citedChunks": [ # List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. - { # Fact Chunk. + { # Fact chunk for grounding check. "chunkText": "A String", # Text content of the fact chunk. Can be at most 10K characters long. - "index": 42, # The index of this chunk. Currently, only used for the streaming mode. - "source": "A String", # Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved. - "sourceMetadata": { # More fine-grained information for the source reference. - "a_key": "A String", - }, + "source": "A String", # Source from which this fact chunk was retrieved. For a fact chunk retrieved from inline facts, this field will contain the index of the specific fact from which this chunk was retrieved. }, ], "claims": [ # Claim texts and citation info across all claims in the answer candidate. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.cmekConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.cmekConfigs.html new file mode 100644 index 0000000000..f4e227d42e --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.cmekConfigs.html @@ -0,0 +1,195 @@ + + + +

Discovery Engine API . projects . locations . cmekConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets the CmekConfig.

+

+ list(parent, x__xgafv=None)

+

Lists all the CmekConfigs with the project.

+

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

+

Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets the CmekConfig.
+
+Args:
+  name: string, Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Configurations used to enable CMEK data encryption with Cloud KMS keys.
+  "isDefault": True or False, # Output only. The default CmekConfig for the Customer.
+  "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+  "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+  "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
+  "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.
+  "state": "A String", # Output only. State of the CmekConfig.
+}
+
+ +
+ list(parent, x__xgafv=None) +
Lists all the CmekConfigs with the project.
+
+Args:
+  parent: string, Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned. (required)
+  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 CmekConfigService.ListCmekConfigs method.
+  "cmekConfigs": [ # All the customer's CmekConfigs.
+    { # Configurations used to enable CMEK data encryption with Cloud KMS keys.
+      "isDefault": True or False, # Output only. The default CmekConfig for the Customer.
+      "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+      "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+      "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
+      "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.
+      "state": "A String", # Output only. State of the CmekConfig.
+    },
+  ],
+}
+
+ +
+ patch(name, body=None, setDefault=None, x__xgafv=None) +
Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.
+
+Args:
+  name: string, Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Configurations used to enable CMEK data encryption with Cloud KMS keys.
+  "isDefault": True or False, # Output only. The default CmekConfig for the Customer.
+  "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+  "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+  "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
+  "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.
+  "state": "A String", # Output only. State of the CmekConfig.
+}
+
+  setDefault: boolean, Set the following CmekConfig as the default to be used for child resources if one is not specified.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.html index 7411804104..9c9358b649 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.html @@ -113,7 +113,7 @@

Method Details

"dataIngestionSource": "A String", # The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming. "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed. "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document. - "fhirResource": "A String", # Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} + "fhirResource": "A String", # Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} "uri": "A String", # If match by URI, the URI of the Document. }, "state": "A String", # The state of the document. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.controls.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.controls.html index fa7b779c1c..f7c814238c 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.controls.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.controls.html @@ -127,7 +127,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -181,7 +182,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -259,7 +261,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -324,7 +327,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -396,7 +400,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -450,7 +455,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.customModels.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.customModels.html index 8c7e7165c3..7f88384c92 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.customModels.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.customModels.html @@ -103,7 +103,7 @@

Method Details

{ # Response message for SearchTuningService.ListCustomModels method. "models": [ # List of custom tuning models. { # Metadata that describes a custom tuned model. - "createTime": "A String", # Timestamp the Model was created at. + "createTime": "A String", # Deprecated: Timestamp the Model was created at. "displayName": "A String", # The display name of the model. "errorMessage": "A String", # Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`. "metrics": { # The metrics of the trained model. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html index c9dea86118..a1572eefd8 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html @@ -146,7 +146,7 @@

Instance Methods

completeQuery(dataStore, includeTailSuggestions=None, query=None, queryModel=None, userPseudoId=None, x__xgafv=None)

Completes the specified user input with keyword suggestions.

- create(parent, body=None, createAdvancedSiteSearch=None, dataStoreId=None, skipDefaultSchemaCreation=None, x__xgafv=None)

+ create(parent, body=None, cmekConfigName=None, createAdvancedSiteSearch=None, dataStoreId=None, disableCmek=None, skipDefaultSchemaCreation=None, x__xgafv=None)

Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.

delete(name, x__xgafv=None)

@@ -213,7 +213,7 @@

Method Details

- create(parent, body=None, createAdvancedSiteSearch=None, dataStoreId=None, skipDefaultSchemaCreation=None, x__xgafv=None) + create(parent, body=None, cmekConfigName=None, createAdvancedSiteSearch=None, dataStoreId=None, disableCmek=None, skipDefaultSchemaCreation=None, x__xgafv=None)
Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
 
 Args:
@@ -223,6 +223,10 @@ 

Method Details

{ # DataStore captures global settings and configs at the DataStore level. "aclEnabled": True or False, # Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + "disableAutomaticRefresh": True or False, # If set true, automatic refresh is disabled for the DataStore. + "disableInitialIndex": True or False, # If set true, initial indexing is disabled for the DataStore. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -231,6 +235,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -277,6 +289,7 @@

Method Details

"idpType": "A String", # Identity provider type configured. }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. @@ -328,8 +341,10 @@

Method Details

}, } + cmekConfigName: string, Resource name of the CmekConfig to use for protecting this DataStore. createAdvancedSiteSearch: boolean, A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. dataStoreId: string, Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. 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. + disableCmek: boolean, DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. skipDefaultSchemaCreation: boolean, A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. x__xgafv: string, V1 error format. Allowed values @@ -411,6 +426,10 @@

Method Details

{ # DataStore captures global settings and configs at the DataStore level. "aclEnabled": True or False, # Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + "disableAutomaticRefresh": True or False, # If set true, automatic refresh is disabled for the DataStore. + "disableInitialIndex": True or False, # If set true, initial indexing is disabled for the DataStore. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -419,6 +438,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -465,6 +492,7 @@

Method Details

"idpType": "A String", # Identity provider type configured. }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. @@ -608,6 +636,10 @@

Method Details

"dataStores": [ # All the customer's DataStores. { # DataStore captures global settings and configs at the DataStore level. "aclEnabled": True or False, # Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + "disableAutomaticRefresh": True or False, # If set true, automatic refresh is disabled for the DataStore. + "disableInitialIndex": True or False, # If set true, initial indexing is disabled for the DataStore. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -616,6 +648,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -662,6 +702,7 @@

Method Details

"idpType": "A String", # Identity provider type configured. }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. @@ -742,6 +783,10 @@

Method Details

{ # DataStore captures global settings and configs at the DataStore level. "aclEnabled": True or False, # Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + "disableAutomaticRefresh": True or False, # If set true, automatic refresh is disabled for the DataStore. + "disableInitialIndex": True or False, # If set true, initial indexing is disabled for the DataStore. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -750,6 +795,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -796,6 +849,7 @@

Method Details

"idpType": "A String", # Identity provider type configured. }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. @@ -858,6 +912,10 @@

Method Details

{ # DataStore captures global settings and configs at the DataStore level. "aclEnabled": True or False, # Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + "disableAutomaticRefresh": True or False, # If set true, automatic refresh is disabled for the DataStore. + "disableInitialIndex": True or False, # If set true, initial indexing is disabled for the DataStore. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -866,6 +924,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -912,6 +978,7 @@

Method Details

"idpType": "A String", # Identity provider type configured. }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. 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 b40cc51ad4..aed8b11a5e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -334,7 +334,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -460,6 +460,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -572,6 +573,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -690,6 +692,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -791,6 +794,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -1112,6 +1116,7 @@

Method Details

], }, "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html index 0c8c986aff..02d5b80b51 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html @@ -191,7 +191,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.controls.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.controls.html index 055d021094..0a9a721dbd 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.controls.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.controls.html @@ -127,7 +127,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -181,7 +182,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -259,7 +261,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -324,7 +327,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -396,7 +400,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -450,7 +455,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. 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 cdfc0b548d..1f8ee3a099 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -334,7 +334,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -460,6 +460,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -572,6 +573,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -690,6 +692,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -791,6 +794,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -1112,6 +1116,7 @@

Method Details

], }, "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html index 0ab913ee1a..82847febfa 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html @@ -191,7 +191,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.html index b37e7c35a8..3deef17fcb 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.html @@ -113,7 +113,7 @@

Method Details

"dataIngestionSource": "A String", # The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming. "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed. "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document. - "fhirResource": "A String", # Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} + "fhirResource": "A String", # Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} "uri": "A String", # If match by URI, the URI of the Document. }, "state": "A String", # The state of the document. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.controls.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.controls.html index c60fd05984..b5c29ff1ef 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.controls.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.controls.html @@ -127,7 +127,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -181,7 +182,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -259,7 +261,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -324,7 +327,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -396,7 +400,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -450,7 +455,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html index ce5309f174..cd74a1fcd9 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html @@ -141,7 +141,7 @@

Instance Methods

completeQuery(dataStore, includeTailSuggestions=None, query=None, queryModel=None, userPseudoId=None, x__xgafv=None)

Completes the specified user input with keyword suggestions.

- create(parent, body=None, createAdvancedSiteSearch=None, dataStoreId=None, skipDefaultSchemaCreation=None, x__xgafv=None)

+ create(parent, body=None, cmekConfigName=None, createAdvancedSiteSearch=None, dataStoreId=None, disableCmek=None, skipDefaultSchemaCreation=None, x__xgafv=None)

Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.

delete(name, x__xgafv=None)

@@ -205,7 +205,7 @@

Method Details

- create(parent, body=None, createAdvancedSiteSearch=None, dataStoreId=None, skipDefaultSchemaCreation=None, x__xgafv=None) + create(parent, body=None, cmekConfigName=None, createAdvancedSiteSearch=None, dataStoreId=None, disableCmek=None, skipDefaultSchemaCreation=None, x__xgafv=None)
Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
 
 Args:
@@ -215,6 +215,10 @@ 

Method Details

{ # DataStore captures global settings and configs at the DataStore level. "aclEnabled": True or False, # Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + "disableAutomaticRefresh": True or False, # If set true, automatic refresh is disabled for the DataStore. + "disableInitialIndex": True or False, # If set true, initial indexing is disabled for the DataStore. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -223,6 +227,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -269,6 +281,7 @@

Method Details

"idpType": "A String", # Identity provider type configured. }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. @@ -320,8 +333,10 @@

Method Details

}, } + cmekConfigName: string, Resource name of the CmekConfig to use for protecting this DataStore. createAdvancedSiteSearch: boolean, A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. dataStoreId: string, Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. 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. + disableCmek: boolean, DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. skipDefaultSchemaCreation: boolean, A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. x__xgafv: string, V1 error format. Allowed values @@ -403,6 +418,10 @@

Method Details

{ # DataStore captures global settings and configs at the DataStore level. "aclEnabled": True or False, # Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + "disableAutomaticRefresh": True or False, # If set true, automatic refresh is disabled for the DataStore. + "disableInitialIndex": True or False, # If set true, initial indexing is disabled for the DataStore. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -411,6 +430,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -457,6 +484,7 @@

Method Details

"idpType": "A String", # Identity provider type configured. }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. @@ -600,6 +628,10 @@

Method Details

"dataStores": [ # All the customer's DataStores. { # DataStore captures global settings and configs at the DataStore level. "aclEnabled": True or False, # Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + "disableAutomaticRefresh": True or False, # If set true, automatic refresh is disabled for the DataStore. + "disableInitialIndex": True or False, # If set true, initial indexing is disabled for the DataStore. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -608,6 +640,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -654,6 +694,7 @@

Method Details

"idpType": "A String", # Identity provider type configured. }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. @@ -734,6 +775,10 @@

Method Details

{ # DataStore captures global settings and configs at the DataStore level. "aclEnabled": True or False, # Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + "disableAutomaticRefresh": True or False, # If set true, automatic refresh is disabled for the DataStore. + "disableInitialIndex": True or False, # If set true, initial indexing is disabled for the DataStore. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -742,6 +787,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -788,6 +841,7 @@

Method Details

"idpType": "A String", # Identity provider type configured. }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. @@ -850,6 +904,10 @@

Method Details

{ # DataStore captures global settings and configs at the DataStore level. "aclEnabled": True or False, # Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + "disableAutomaticRefresh": True or False, # If set true, automatic refresh is disabled for the DataStore. + "disableInitialIndex": True or False, # If set true, initial indexing is disabled for the DataStore. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -858,6 +916,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -904,6 +970,7 @@

Method Details

"idpType": "A String", # Identity provider type configured. }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index c984cb18af..0082e9c343 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -334,7 +334,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -460,6 +460,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -572,6 +573,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -690,6 +692,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -791,6 +794,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -1112,6 +1116,7 @@

Method Details

], }, "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html index abb9c00812..4888a055d7 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html @@ -191,7 +191,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html index 8b34e5873d..10fb2b4184 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html @@ -261,6 +261,7 @@

Method Details

], }, "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -526,6 +527,7 @@

Method Details

], }, "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -767,6 +769,7 @@

Method Details

], }, "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.groundingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.groundingConfigs.html index 2c78b36bee..9185382a72 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.groundingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.groundingConfigs.html @@ -91,7 +91,7 @@

Method Details

The object takes the form of: { # Request message for GroundedGenerationService.CheckGrounding method. - "answerCandidate": "A String", # Answer candidate to check. Can have a maximum length of 1024 characters. + "answerCandidate": "A String", # Answer candidate to check. It can have a maximum length of 4096 tokens. "facts": [ # List of facts for the grounding check. We support up to 200 facts. { # Grounding Fact. "attributes": { # Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on. @@ -118,13 +118,9 @@

Method Details

{ # Response message for the GroundedGenerationService.CheckGrounding method. "citedChunks": [ # List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. - { # Fact Chunk. + { # Fact chunk for grounding check. "chunkText": "A String", # Text content of the fact chunk. Can be at most 10K characters long. - "index": 42, # The index of this chunk. Currently, only used for the streaming mode. - "source": "A String", # Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved. - "sourceMetadata": { # More fine-grained information for the source reference. - "a_key": "A String", - }, + "source": "A String", # Source from which this fact chunk was retrieved. For a fact chunk retrieved from inline facts, this field will contain the index of the specific fact from which this chunk was retrieved. }, ], "claims": [ # Claim texts and citation info across all claims in the answer candidate. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index b4268c363a..ccdb6e6948 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -74,6 +74,11 @@

Discovery Engine API . projects . locations

Instance Methods

+

+ cmekConfigs() +

+

Returns the cmekConfigs Resource.

+

collections()

@@ -138,9 +143,15 @@

Instance Methods

getAclConfig(name, x__xgafv=None)

Gets the AclConfig.

+

+ getCmekConfig(name, x__xgafv=None)

+

Gets the CmekConfig.

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

Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.

+

+ updateCmekConfig(name, body=None, setDefault=None, x__xgafv=None)

+

Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.

Method Details

close() @@ -242,6 +253,30 @@

Method Details

}
+
+ getCmekConfig(name, x__xgafv=None) +
Gets the CmekConfig.
+
+Args:
+  name: string, Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Configurations used to enable CMEK data encryption with Cloud KMS keys.
+  "isDefault": True or False, # Output only. The default CmekConfig for the Customer.
+  "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+  "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+  "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
+  "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.
+  "state": "A String", # Output only. State of the CmekConfig.
+}
+
+
updateAclConfig(name, body=None, x__xgafv=None)
Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.
@@ -280,4 +315,52 @@ 

Method Details

}
+
+ updateCmekConfig(name, body=None, setDefault=None, x__xgafv=None) +
Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.
+
+Args:
+  name: string, Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Configurations used to enable CMEK data encryption with Cloud KMS keys.
+  "isDefault": True or False, # Output only. The default CmekConfig for the Customer.
+  "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+  "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+  "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
+  "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.
+  "state": "A String", # Output only. State of the CmekConfig.
+}
+
+  setDefault: boolean, Set the following CmekConfig as the default to be used for child resources if one is not specified.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.html index 169fd438c0..080d01da9f 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.html @@ -113,7 +113,7 @@

Method Details

"dataIngestionSource": "A String", # The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming. "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed. "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document. - "fhirResource": "A String", # Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} + "fhirResource": "A String", # Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} "uri": "A String", # If match by URI, the URI of the Document. }, "state": "A String", # The state of the document. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.controls.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.controls.html index 01019e7df8..a49c0e1bf3 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.controls.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.controls.html @@ -127,7 +127,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -181,7 +182,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -259,7 +261,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -324,7 +327,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -396,7 +400,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -450,7 +455,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.customModels.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.customModels.html index cab73c7d78..c2f764612c 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.customModels.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.customModels.html @@ -103,7 +103,7 @@

Method Details

{ # Response message for SearchTuningService.ListCustomModels method. "models": [ # List of custom tuning models. { # Metadata that describes a custom tuned model. - "createTime": "A String", # Timestamp the Model was created at. + "createTime": "A String", # Deprecated: Timestamp the Model was created at. "displayName": "A String", # The display name of the model. "errorMessage": "A String", # Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`. "metrics": { # The metrics of the trained model. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html index 3df9004141..ceb6649675 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html @@ -146,7 +146,7 @@

Instance Methods

completeQuery(dataStore, includeTailSuggestions=None, query=None, queryModel=None, userPseudoId=None, x__xgafv=None)

Completes the specified user input with keyword suggestions.

- create(parent, body=None, createAdvancedSiteSearch=None, dataStoreId=None, skipDefaultSchemaCreation=None, x__xgafv=None)

+ create(parent, body=None, cmekConfigName=None, createAdvancedSiteSearch=None, dataStoreId=None, disableCmek=None, skipDefaultSchemaCreation=None, x__xgafv=None)

Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.

delete(name, x__xgafv=None)

@@ -207,7 +207,7 @@

Method Details

- create(parent, body=None, createAdvancedSiteSearch=None, dataStoreId=None, skipDefaultSchemaCreation=None, x__xgafv=None) + create(parent, body=None, cmekConfigName=None, createAdvancedSiteSearch=None, dataStoreId=None, disableCmek=None, skipDefaultSchemaCreation=None, x__xgafv=None)
Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
 
 Args:
@@ -216,6 +216,8 @@ 

Method Details

The object takes the form of: { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -224,6 +226,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -264,6 +274,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. @@ -295,8 +306,10 @@

Method Details

}, } + cmekConfigName: string, Resource name of the CmekConfig to use for protecting this DataStore. createAdvancedSiteSearch: boolean, A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. dataStoreId: string, Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. 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. + disableCmek: boolean, DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. skipDefaultSchemaCreation: boolean, A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. x__xgafv: string, V1 error format. Allowed values @@ -377,6 +390,8 @@

Method Details

An object of the form: { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -385,6 +400,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -425,6 +448,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. @@ -496,6 +520,8 @@

Method Details

{ # Response message for DataStoreService.ListDataStores method. "dataStores": [ # All the customer's DataStores. { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -504,6 +530,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -544,6 +578,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. @@ -603,6 +638,8 @@

Method Details

The object takes the form of: { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -611,6 +648,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -651,6 +696,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. @@ -692,6 +738,8 @@

Method Details

An object of the form: { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -700,6 +748,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -740,6 +796,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. 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 5275a0926b..122eb8af46 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -331,7 +331,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -449,6 +449,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -553,6 +554,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -663,6 +665,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -756,6 +759,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -1061,6 +1065,7 @@

Method Details

], }, "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html index c677653336..8557044158 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html @@ -191,7 +191,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.controls.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.controls.html index 7544d710ed..42154ae747 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.controls.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.controls.html @@ -127,7 +127,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -181,7 +182,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -259,7 +261,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -324,7 +327,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -396,7 +400,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -450,7 +455,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. 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 193edc7197..385e018b56 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -331,7 +331,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -449,6 +449,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -553,6 +554,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -663,6 +665,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -756,6 +759,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -1061,6 +1065,7 @@

Method Details

], }, "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html index f26297521d..bcb7432436 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html @@ -191,7 +191,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.html index 4f7fa514c2..a88679f2b2 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.html @@ -113,7 +113,7 @@

Method Details

"dataIngestionSource": "A String", # The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming. "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed. "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document. - "fhirResource": "A String", # Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} + "fhirResource": "A String", # Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} "uri": "A String", # If match by URI, the URI of the Document. }, "state": "A String", # The state of the document. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.controls.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.controls.html index 1315af4b9e..e427f64fff 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.controls.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.controls.html @@ -127,7 +127,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -181,7 +182,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -259,7 +261,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -324,7 +327,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -396,7 +400,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. @@ -450,7 +455,8 @@

Method Details

"startTime": "A String", # Start of time range. Range is inclusive. }, ], - "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. + "queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case. + "queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms. { # Matcher for search request query "fullMatch": True or False, # Whether the search query needs to exactly match the query term. "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html index 2abd24000d..d071c52fe3 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html @@ -141,7 +141,7 @@

Instance Methods

completeQuery(dataStore, includeTailSuggestions=None, query=None, queryModel=None, userPseudoId=None, x__xgafv=None)

Completes the specified user input with keyword suggestions.

- create(parent, body=None, createAdvancedSiteSearch=None, dataStoreId=None, skipDefaultSchemaCreation=None, x__xgafv=None)

+ create(parent, body=None, cmekConfigName=None, createAdvancedSiteSearch=None, dataStoreId=None, disableCmek=None, skipDefaultSchemaCreation=None, x__xgafv=None)

Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.

delete(name, x__xgafv=None)

@@ -199,7 +199,7 @@

Method Details

- create(parent, body=None, createAdvancedSiteSearch=None, dataStoreId=None, skipDefaultSchemaCreation=None, x__xgafv=None) + create(parent, body=None, cmekConfigName=None, createAdvancedSiteSearch=None, dataStoreId=None, disableCmek=None, skipDefaultSchemaCreation=None, x__xgafv=None)
Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
 
 Args:
@@ -208,6 +208,8 @@ 

Method Details

The object takes the form of: { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -216,6 +218,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -256,6 +266,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. @@ -287,8 +298,10 @@

Method Details

}, } + cmekConfigName: string, Resource name of the CmekConfig to use for protecting this DataStore. createAdvancedSiteSearch: boolean, A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. dataStoreId: string, Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. 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. + disableCmek: boolean, DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. skipDefaultSchemaCreation: boolean, A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. x__xgafv: string, V1 error format. Allowed values @@ -369,6 +382,8 @@

Method Details

An object of the form: { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -377,6 +392,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -417,6 +440,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. @@ -488,6 +512,8 @@

Method Details

{ # Response message for DataStoreService.ListDataStores method. "dataStores": [ # All the customer's DataStores. { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -496,6 +522,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -536,6 +570,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. @@ -595,6 +630,8 @@

Method Details

The object takes the form of: { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -603,6 +640,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -643,6 +688,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. @@ -684,6 +730,8 @@

Method Details

An object of the form: { # DataStore captures global settings and configs at the DataStore level. + "advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search. + }, "billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing. "structuredDataSize": "A String", # Data size for structured data in terms of bytes. "structuredDataUpdateTime": "A String", # Last updated timestamp for structured data. @@ -692,6 +740,14 @@

Method Details

"websiteDataSize": "A String", # Data size for websites in terms of bytes. "websiteDataUpdateTime": "A String", # Last updated timestamp for websites. }, + "cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore. + "isDefault": True or False, # Output only. The default CmekConfig for the Customer. + "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. + "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. + "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + "state": "A String", # Output only. State of the CmekConfig. + }, "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. @@ -732,6 +788,7 @@

Method Details

}, }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. + "kmsKeyName": "A String", # Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. "languageInfo": { # Language info for DataStore. # Language info for DataStore. "language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. "languageCode": "A String", # The language code for the DataStore. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index 90fdd9d331..2d71b4412b 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -331,7 +331,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -449,6 +449,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -553,6 +554,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -663,6 +665,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -756,6 +759,7 @@

Method Details

"contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion. + "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. "demotionEventType": "A String", # Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. }, "modelId": "A String", # The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. @@ -1061,6 +1065,7 @@

Method Details

], }, "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html index 4f90079c55..6f33a542ed 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html @@ -191,7 +191,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html index 4e2a36297c..8f4097d183 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html @@ -258,6 +258,7 @@

Method Details

], }, "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -520,6 +521,7 @@

Method Details

], }, "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -758,6 +760,7 @@

Method Details

], }, "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.groundingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.groundingConfigs.html index 0ffc51c6fa..3fa814a742 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.groundingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.groundingConfigs.html @@ -91,7 +91,7 @@

Method Details

The object takes the form of: { # Request message for GroundedGenerationService.CheckGrounding method. - "answerCandidate": "A String", # Answer candidate to check. Can have a maximum length of 1024 characters. + "answerCandidate": "A String", # Answer candidate to check. It can have a maximum length of 4096 tokens. "facts": [ # List of facts for the grounding check. We support up to 200 facts. { # Grounding Fact. "attributes": { # Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on. @@ -118,13 +118,9 @@

Method Details

{ # Response message for the GroundedGenerationService.CheckGrounding method. "citedChunks": [ # List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. - { # Fact Chunk. + { # Fact chunk for grounding check. "chunkText": "A String", # Text content of the fact chunk. Can be at most 10K characters long. - "index": 42, # The index of this chunk. Currently, only used for the streaming mode. - "source": "A String", # Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved. - "sourceMetadata": { # More fine-grained information for the source reference. - "a_key": "A String", - }, + "source": "A String", # Source from which this fact chunk was retrieved. For a fact chunk retrieved from inline facts, this field will contain the index of the specific fact from which this chunk was retrieved. }, ], "claims": [ # Claim texts and citation info across all claims in the answer candidate. diff --git a/docs/dyn/displayvideo_v2.advertisers.campaigns.html b/docs/dyn/displayvideo_v2.advertisers.campaigns.html index d139f61aa7..54a83b208f 100644 --- a/docs/dyn/displayvideo_v2.advertisers.campaigns.html +++ b/docs/dyn/displayvideo_v2.advertisers.campaigns.html @@ -719,8 +719,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, diff --git a/docs/dyn/displayvideo_v2.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html index 714e1b3e4d..36a559fbcb 100644 --- a/docs/dyn/displayvideo_v2.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html @@ -380,8 +380,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -754,8 +754,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, diff --git a/docs/dyn/displayvideo_v2.advertisers.html b/docs/dyn/displayvideo_v2.advertisers.html index 2df6401cee..3562b3d9e1 100644 --- a/docs/dyn/displayvideo_v2.advertisers.html +++ b/docs/dyn/displayvideo_v2.advertisers.html @@ -233,8 +233,8 @@

Method Details

}, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system. - "billingConfig": { # Billing related settings of an advertiser. # Optional. Required. Billing related settings of the advertiser. - "billingProfileId": "A String", # Optional. The ID of a billing profile assigned to the advertiser. + "billingConfig": { # Billing related settings of an advertiser. # Required. Billing related settings of the advertiser. + "billingProfileId": "A String", # Required. The ID of a billing profile assigned to the advertiser. }, "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser. "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives. @@ -299,8 +299,8 @@

Method Details

}, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system. - "billingConfig": { # Billing related settings of an advertiser. # Optional. Required. Billing related settings of the advertiser. - "billingProfileId": "A String", # Optional. The ID of a billing profile assigned to the advertiser. + "billingConfig": { # Billing related settings of an advertiser. # Required. Billing related settings of the advertiser. + "billingProfileId": "A String", # Required. The ID of a billing profile assigned to the advertiser. }, "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser. "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives. @@ -590,8 +590,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -914,8 +914,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -1031,8 +1031,8 @@

Method Details

}, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system. - "billingConfig": { # Billing related settings of an advertiser. # Optional. Required. Billing related settings of the advertiser. - "billingProfileId": "A String", # Optional. The ID of a billing profile assigned to the advertiser. + "billingConfig": { # Billing related settings of an advertiser. # Required. Billing related settings of the advertiser. + "billingProfileId": "A String", # Required. The ID of a billing profile assigned to the advertiser. }, "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser. "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives. @@ -1110,8 +1110,8 @@

Method Details

}, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system. - "billingConfig": { # Billing related settings of an advertiser. # Optional. Required. Billing related settings of the advertiser. - "billingProfileId": "A String", # Optional. The ID of a billing profile assigned to the advertiser. + "billingConfig": { # Billing related settings of an advertiser. # Required. Billing related settings of the advertiser. + "billingProfileId": "A String", # Required. The ID of a billing profile assigned to the advertiser. }, "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser. "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives. @@ -1393,8 +1393,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -1534,8 +1534,8 @@

Method Details

}, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system. - "billingConfig": { # Billing related settings of an advertiser. # Optional. Required. Billing related settings of the advertiser. - "billingProfileId": "A String", # Optional. The ID of a billing profile assigned to the advertiser. + "billingConfig": { # Billing related settings of an advertiser. # Required. Billing related settings of the advertiser. + "billingProfileId": "A String", # Required. The ID of a billing profile assigned to the advertiser. }, "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser. "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives. @@ -1601,8 +1601,8 @@

Method Details

}, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system. - "billingConfig": { # Billing related settings of an advertiser. # Optional. Required. Billing related settings of the advertiser. - "billingProfileId": "A String", # Optional. The ID of a billing profile assigned to the advertiser. + "billingConfig": { # Billing related settings of an advertiser. # Required. Billing related settings of the advertiser. + "billingProfileId": "A String", # Required. The ID of a billing profile assigned to the advertiser. }, "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser. "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives. diff --git a/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html index 6d22fa91a2..de7d5f1ce4 100644 --- a/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html +++ b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html @@ -771,8 +771,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, diff --git a/docs/dyn/displayvideo_v2.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html index eb59740056..3a319dc7ab 100644 --- a/docs/dyn/displayvideo_v2.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html @@ -380,8 +380,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -689,8 +689,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -1129,8 +1129,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -1503,8 +1503,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, diff --git a/docs/dyn/displayvideo_v2.advertisers.lineItems.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.html index 34bac118b9..9fa5cda5bb 100644 --- a/docs/dyn/displayvideo_v2.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.html @@ -353,8 +353,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -721,8 +721,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, diff --git a/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html index 9fe73547fc..ab3980a091 100644 --- a/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -380,8 +380,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -689,8 +689,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -1129,8 +1129,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -1503,8 +1503,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, diff --git a/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html index 4fc8aa2fae..3d5511e2da 100644 --- a/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html @@ -379,8 +379,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -688,8 +688,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -1126,8 +1126,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -1499,8 +1499,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html index 5bdc0a60ef..0c34a77e87 100644 --- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html +++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html @@ -342,8 +342,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html index 2884d54878..10e30e9e6a 100644 --- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html @@ -380,8 +380,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -754,8 +754,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, diff --git a/docs/dyn/displayvideo_v2.partners.html b/docs/dyn/displayvideo_v2.partners.html index 3995922124..c2c042c75c 100644 --- a/docs/dyn/displayvideo_v2.partners.html +++ b/docs/dyn/displayvideo_v2.partners.html @@ -339,8 +339,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -663,8 +663,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, diff --git a/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html index b01a7d31f0..be814f7f1c 100644 --- a/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html @@ -379,8 +379,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -688,8 +688,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -1126,8 +1126,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, @@ -1499,8 +1499,8 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], }, diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.html index 8a50c7cf07..2a372e8196 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroups.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.html @@ -342,10 +342,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. + "A String", + ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html index 3ccba4e412..dec35178e1 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html @@ -380,10 +380,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. + "A String", + ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -754,10 +771,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. + "A String", + ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. "A String", ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. diff --git a/docs/dyn/displayvideo_v3.advertisers.campaigns.html b/docs/dyn/displayvideo_v3.advertisers.campaigns.html index 802cd059ee..989fb41ccb 100644 --- a/docs/dyn/displayvideo_v3.advertisers.campaigns.html +++ b/docs/dyn/displayvideo_v3.advertisers.campaigns.html @@ -719,10 +719,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. + "A String", + ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. diff --git a/docs/dyn/displayvideo_v3.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html index 5c68b7993c..cfa8ce3675 100644 --- a/docs/dyn/displayvideo_v3.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html @@ -380,10 +380,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. + "A String", + ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -754,10 +771,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. + "A String", + ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. "A String", ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. diff --git a/docs/dyn/displayvideo_v3.advertisers.html b/docs/dyn/displayvideo_v3.advertisers.html index c4a02ca5bb..cce937c2b8 100644 --- a/docs/dyn/displayvideo_v3.advertisers.html +++ b/docs/dyn/displayvideo_v3.advertisers.html @@ -228,8 +228,8 @@

Method Details

}, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system. - "billingConfig": { # Billing related settings of an advertiser. # Optional. Required. Billing related settings of the advertiser. - "billingProfileId": "A String", # Optional. The ID of a billing profile assigned to the advertiser. + "billingConfig": { # Billing related settings of an advertiser. # Required. Billing related settings of the advertiser. + "billingProfileId": "A String", # Required. The ID of a billing profile assigned to the advertiser. }, "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser. "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives. @@ -294,8 +294,8 @@

Method Details

}, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system. - "billingConfig": { # Billing related settings of an advertiser. # Optional. Required. Billing related settings of the advertiser. - "billingProfileId": "A String", # Optional. The ID of a billing profile assigned to the advertiser. + "billingConfig": { # Billing related settings of an advertiser. # Required. Billing related settings of the advertiser. + "billingProfileId": "A String", # Required. The ID of a billing profile assigned to the advertiser. }, "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser. "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives. @@ -585,10 +585,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. + "A String", + ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -909,10 +926,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. + "A String", + ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. "A String", ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -1026,8 +1060,8 @@

Method Details

}, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system. - "billingConfig": { # Billing related settings of an advertiser. # Optional. Required. Billing related settings of the advertiser. - "billingProfileId": "A String", # Optional. The ID of a billing profile assigned to the advertiser. + "billingConfig": { # Billing related settings of an advertiser. # Required. Billing related settings of the advertiser. + "billingProfileId": "A String", # Required. The ID of a billing profile assigned to the advertiser. }, "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser. "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives. @@ -1105,8 +1139,8 @@

Method Details

}, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system. - "billingConfig": { # Billing related settings of an advertiser. # Optional. Required. Billing related settings of the advertiser. - "billingProfileId": "A String", # Optional. The ID of a billing profile assigned to the advertiser. + "billingConfig": { # Billing related settings of an advertiser. # Required. Billing related settings of the advertiser. + "billingProfileId": "A String", # Required. The ID of a billing profile assigned to the advertiser. }, "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser. "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives. @@ -1388,10 +1422,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. + "A String", + ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. "A String", ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -1529,8 +1580,8 @@

Method Details

}, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system. - "billingConfig": { # Billing related settings of an advertiser. # Optional. Required. Billing related settings of the advertiser. - "billingProfileId": "A String", # Optional. The ID of a billing profile assigned to the advertiser. + "billingConfig": { # Billing related settings of an advertiser. # Required. Billing related settings of the advertiser. + "billingProfileId": "A String", # Required. The ID of a billing profile assigned to the advertiser. }, "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser. "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives. @@ -1596,8 +1647,8 @@

Method Details

}, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system. - "billingConfig": { # Billing related settings of an advertiser. # Optional. Required. Billing related settings of the advertiser. - "billingProfileId": "A String", # Optional. The ID of a billing profile assigned to the advertiser. + "billingConfig": { # Billing related settings of an advertiser. # Required. Billing related settings of the advertiser. + "billingProfileId": "A String", # Required. The ID of a billing profile assigned to the advertiser. }, "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser. "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives. diff --git a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html index 662d55bf4a..02fef97af9 100644 --- a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html +++ b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html @@ -799,10 +799,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. + "A String", + ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. diff --git a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html index 7ecd59c694..205add852e 100644 --- a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html @@ -380,10 +380,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. + "A String", + ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -689,10 +706,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. + "A String", + ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. "A String", ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -1129,10 +1163,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. + "A String", + ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -1503,10 +1554,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. + "A String", + ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. "A String", ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. diff --git a/docs/dyn/displayvideo_v3.advertisers.lineItems.html b/docs/dyn/displayvideo_v3.advertisers.lineItems.html index 146039cc30..9222b23047 100644 --- a/docs/dyn/displayvideo_v3.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.html @@ -353,10 +353,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. + "A String", + ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -721,10 +738,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. + "A String", + ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. "A String", ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. diff --git a/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html index 64034e6f90..a64281232f 100644 --- a/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -380,10 +380,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. + "A String", + ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -689,10 +706,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. + "A String", + ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. "A String", ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -1129,10 +1163,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. + "A String", + ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -1503,10 +1554,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. + "A String", + ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. "A String", ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. diff --git a/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html index 45d46b16e5..81c0dbaa56 100644 --- a/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html @@ -379,10 +379,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. + "A String", + ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -688,10 +705,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. + "A String", + ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. "A String", ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -1126,10 +1160,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. + "A String", + ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -1499,10 +1550,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. + "A String", + ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. "A String", ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. diff --git a/docs/dyn/displayvideo_v3.partners.html b/docs/dyn/displayvideo_v3.partners.html index cf1de01f35..313d8bb37d 100644 --- a/docs/dyn/displayvideo_v3.partners.html +++ b/docs/dyn/displayvideo_v3.partners.html @@ -339,10 +339,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. + "A String", + ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -663,10 +680,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. + "A String", + ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. "A String", ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. diff --git a/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html index 838322ec60..c0404c931c 100644 --- a/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html @@ -379,10 +379,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. + "A String", + ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -688,10 +705,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. + "A String", + ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. "A String", ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -1126,10 +1160,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. "A String", ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. + "A String", + ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. @@ -1499,10 +1550,27 @@

Method Details

}, "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 settings. # Third party brand verifier -- Adloox. - "excludedAdlooxCategories": [ # Adloox's brand safety settings. + "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox. + "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads. + "excludedAdlooxCategories": [ # Adloox categories to exclude. + "A String", + ], + "excludedFraudIvtMfaCategories": [ # Optional. Adloox's fraud IVT MFA categories to exclude. "A String", ], + "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads. }, "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. diff --git a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html index fc649d1f0b..0299245353 100644 --- a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html @@ -118,7 +118,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -414,7 +414,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -734,7 +734,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -1041,7 +1041,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -1356,7 +1356,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -1653,7 +1653,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html index 417fd6a1a6..ad81bb0b1c 100644 --- a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html @@ -2752,7 +2752,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -2773,7 +2773,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -2981,7 +2981,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3535,7 +3535,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3556,7 +3556,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3585,7 +3585,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3637,7 +3637,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3679,7 +3679,7 @@

Method Details

}, "sourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3706,7 +3706,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3758,7 +3758,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3800,7 +3800,7 @@

Method Details

}, "requestedSourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html index d33134c880..6d26c5fdda 100644 --- a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html @@ -135,7 +135,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -198,7 +198,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -814,7 +814,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -877,7 +877,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html index 1d2a8e9e98..d49d0bd3a2 100644 --- a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html @@ -148,7 +148,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -169,7 +169,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -377,7 +377,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -500,7 +500,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -521,7 +521,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -729,7 +729,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -874,7 +874,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -895,7 +895,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -1103,7 +1103,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -1242,7 +1242,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -1263,7 +1263,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -1471,7 +1471,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -1611,7 +1611,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -1632,7 +1632,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -1840,7 +1840,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -1962,7 +1962,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -1983,7 +1983,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -2191,7 +2191,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.organizations.locations.storedInfoTypes.html b/docs/dyn/dlp_v2.organizations.locations.storedInfoTypes.html index 5757c45a00..bc81669618 100644 --- a/docs/dyn/dlp_v2.organizations.locations.storedInfoTypes.html +++ b/docs/dyn/dlp_v2.organizations.locations.storedInfoTypes.html @@ -131,7 +131,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -183,7 +183,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -249,7 +249,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -350,7 +350,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -416,7 +416,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -506,7 +506,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -572,7 +572,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -665,7 +665,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -716,7 +716,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -782,7 +782,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html index 04d432aa7f..c29e389bed 100644 --- a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html @@ -135,7 +135,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -198,7 +198,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -758,7 +758,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -821,7 +821,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.organizations.storedInfoTypes.html b/docs/dyn/dlp_v2.organizations.storedInfoTypes.html index dbd477b65e..f267130e2d 100644 --- a/docs/dyn/dlp_v2.organizations.storedInfoTypes.html +++ b/docs/dyn/dlp_v2.organizations.storedInfoTypes.html @@ -131,7 +131,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -183,7 +183,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -249,7 +249,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -350,7 +350,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -416,7 +416,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -506,7 +506,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -572,7 +572,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -665,7 +665,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -716,7 +716,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -782,7 +782,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.projects.content.html b/docs/dyn/dlp_v2.projects.content.html index 85626e6e6e..1ef31ab9eb 100644 --- a/docs/dyn/dlp_v2.projects.content.html +++ b/docs/dyn/dlp_v2.projects.content.html @@ -2366,7 +2366,7 @@

Method Details

"rowNumber": "A String", # Row number inferred at the time the table was scanned. This value is nondeterministic, cannot be queried, and may be null for inspection jobs. To locate findings within a table, specify `inspect_job.storage_config.big_query_options.identifying_fields` in `CreateDlpJobRequest`. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.projects.dlpJobs.html b/docs/dyn/dlp_v2.projects.dlpJobs.html index 746eb8b837..6be8bbf4cc 100644 --- a/docs/dyn/dlp_v2.projects.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.dlpJobs.html @@ -151,7 +151,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -172,7 +172,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -380,7 +380,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -458,7 +458,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -479,7 +479,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -508,7 +508,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -560,7 +560,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -602,7 +602,7 @@

Method Details

}, "sourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3253,7 +3253,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3274,7 +3274,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3482,7 +3482,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4036,7 +4036,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4057,7 +4057,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4086,7 +4086,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4138,7 +4138,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4180,7 +4180,7 @@

Method Details

}, "sourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4207,7 +4207,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4259,7 +4259,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4301,7 +4301,7 @@

Method Details

}, "requestedSourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -6980,7 +6980,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -7001,7 +7001,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -7209,7 +7209,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -7763,7 +7763,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -7784,7 +7784,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -7813,7 +7813,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -7865,7 +7865,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -7907,7 +7907,7 @@

Method Details

}, "sourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -7934,7 +7934,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -7986,7 +7986,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -8028,7 +8028,7 @@

Method Details

}, "requestedSourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -10701,7 +10701,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -10722,7 +10722,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -10930,7 +10930,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -11484,7 +11484,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -11505,7 +11505,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -11534,7 +11534,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -11586,7 +11586,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -11628,7 +11628,7 @@

Method Details

}, "sourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -11655,7 +11655,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -11707,7 +11707,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -11749,7 +11749,7 @@

Method Details

}, "requestedSourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.projects.image.html b/docs/dyn/dlp_v2.projects.image.html index de6dcf7cf1..2866869828 100644 --- a/docs/dyn/dlp_v2.projects.image.html +++ b/docs/dyn/dlp_v2.projects.image.html @@ -378,7 +378,7 @@

Method Details

"rowNumber": "A String", # Row number inferred at the time the table was scanned. This value is nondeterministic, cannot be queried, and may be null for inspection jobs. To locate findings within a table, specify `inspect_job.storage_config.big_query_options.identifying_fields` in `CreateDlpJobRequest`. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.projects.jobTriggers.html b/docs/dyn/dlp_v2.projects.jobTriggers.html index e41fb602bf..89110c1fea 100644 --- a/docs/dyn/dlp_v2.projects.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.jobTriggers.html @@ -2756,7 +2756,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -2777,7 +2777,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -2985,7 +2985,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3539,7 +3539,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3560,7 +3560,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3589,7 +3589,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3641,7 +3641,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3683,7 +3683,7 @@

Method Details

}, "sourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3710,7 +3710,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3762,7 +3762,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3804,7 +3804,7 @@

Method Details

}, "requestedSourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3866,7 +3866,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3887,7 +3887,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4095,7 +4095,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4218,7 +4218,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4239,7 +4239,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4447,7 +4447,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4592,7 +4592,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4613,7 +4613,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4821,7 +4821,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4960,7 +4960,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4981,7 +4981,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -5189,7 +5189,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -5329,7 +5329,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -5350,7 +5350,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -5558,7 +5558,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -5680,7 +5680,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -5701,7 +5701,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -5909,7 +5909,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.projects.locations.content.html b/docs/dyn/dlp_v2.projects.locations.content.html index 9049abdcad..e142d567b1 100644 --- a/docs/dyn/dlp_v2.projects.locations.content.html +++ b/docs/dyn/dlp_v2.projects.locations.content.html @@ -2366,7 +2366,7 @@

Method Details

"rowNumber": "A String", # Row number inferred at the time the table was scanned. This value is nondeterministic, cannot be queried, and may be null for inspection jobs. To locate findings within a table, specify `inspect_job.storage_config.big_query_options.identifying_fields` in `CreateDlpJobRequest`. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html index 5451b5ff88..98794497db 100644 --- a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html @@ -118,7 +118,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -414,7 +414,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -734,7 +734,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -1041,7 +1041,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -1356,7 +1356,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -1653,7 +1653,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html index d89c87710d..9daa291591 100644 --- a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html @@ -157,7 +157,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -178,7 +178,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -386,7 +386,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -464,7 +464,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -485,7 +485,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -514,7 +514,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -566,7 +566,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -608,7 +608,7 @@

Method Details

}, "sourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3259,7 +3259,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3280,7 +3280,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3488,7 +3488,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4042,7 +4042,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4063,7 +4063,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4092,7 +4092,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4144,7 +4144,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4186,7 +4186,7 @@

Method Details

}, "sourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4213,7 +4213,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4265,7 +4265,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4307,7 +4307,7 @@

Method Details

}, "requestedSourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -7010,7 +7010,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -7031,7 +7031,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -7239,7 +7239,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -7793,7 +7793,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -7814,7 +7814,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -7843,7 +7843,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -7895,7 +7895,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -7937,7 +7937,7 @@

Method Details

}, "sourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -7964,7 +7964,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -8016,7 +8016,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -8058,7 +8058,7 @@

Method Details

}, "requestedSourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -10819,7 +10819,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -10840,7 +10840,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -11048,7 +11048,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -11602,7 +11602,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -11623,7 +11623,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -11652,7 +11652,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -11704,7 +11704,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -11746,7 +11746,7 @@

Method Details

}, "sourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -11773,7 +11773,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -11825,7 +11825,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -11867,7 +11867,7 @@

Method Details

}, "requestedSourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html index 0d44597f52..3caf137d9a 100644 --- a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html @@ -135,7 +135,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -198,7 +198,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -814,7 +814,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -877,7 +877,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.projects.locations.image.html b/docs/dyn/dlp_v2.projects.locations.image.html index f2f7eb1166..3df18d1738 100644 --- a/docs/dyn/dlp_v2.projects.locations.image.html +++ b/docs/dyn/dlp_v2.projects.locations.image.html @@ -378,7 +378,7 @@

Method Details

"rowNumber": "A String", # Row number inferred at the time the table was scanned. This value is nondeterministic, cannot be queried, and may be null for inspection jobs. To locate findings within a table, specify `inspect_job.storage_config.big_query_options.identifying_fields` in `CreateDlpJobRequest`. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html index 21f1589291..e36e0a84a4 100644 --- a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html @@ -2759,7 +2759,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -2780,7 +2780,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -2988,7 +2988,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3542,7 +3542,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3563,7 +3563,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3592,7 +3592,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3644,7 +3644,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3686,7 +3686,7 @@

Method Details

}, "sourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3713,7 +3713,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3765,7 +3765,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Required. Auxiliary table location. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3807,7 +3807,7 @@

Method Details

}, "requestedSourceTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Input dataset to compute metrics over. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3869,7 +3869,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -3890,7 +3890,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4098,7 +4098,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4221,7 +4221,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4242,7 +4242,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4450,7 +4450,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4595,7 +4595,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4616,7 +4616,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -4824,7 +4824,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -5051,7 +5051,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -5072,7 +5072,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -5280,7 +5280,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -5420,7 +5420,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -5441,7 +5441,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -5649,7 +5649,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -5771,7 +5771,7 @@

Method Details

"transformationDetailsStorageConfig": { # Config for storing transformation details. # Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -5792,7 +5792,7 @@

Method Details

"outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage. "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -6000,7 +6000,7 @@

Method Details

"sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.projects.locations.storedInfoTypes.html b/docs/dyn/dlp_v2.projects.locations.storedInfoTypes.html index 544902fee2..5f3e87d658 100644 --- a/docs/dyn/dlp_v2.projects.locations.storedInfoTypes.html +++ b/docs/dyn/dlp_v2.projects.locations.storedInfoTypes.html @@ -131,7 +131,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -183,7 +183,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -249,7 +249,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -350,7 +350,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -416,7 +416,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -506,7 +506,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -572,7 +572,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -665,7 +665,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -716,7 +716,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -782,7 +782,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html index f395a89538..2d2e8019b1 100644 --- a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html @@ -135,7 +135,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -198,7 +198,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -758,7 +758,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -821,7 +821,7 @@

Method Details

"exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/dlp_v2.projects.storedInfoTypes.html b/docs/dyn/dlp_v2.projects.storedInfoTypes.html index 17a09a4b20..ce32e74eb8 100644 --- a/docs/dyn/dlp_v2.projects.storedInfoTypes.html +++ b/docs/dyn/dlp_v2.projects.storedInfoTypes.html @@ -131,7 +131,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -183,7 +183,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -249,7 +249,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -350,7 +350,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -416,7 +416,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -506,7 +506,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -572,7 +572,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -665,7 +665,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -716,7 +716,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, @@ -782,7 +782,7 @@

Method Details

}, "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Source table of the field. "datasetId": "A String", # Dataset ID of the table. - "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. + "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. }, }, diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html index eb8559d268..6756879245 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html @@ -229,6 +229,8 @@

Method Details

}, }, "name": "A String", # Dataset schema resource name. Format: `projects/{project}/locations/{location}/processors/{processor}/dataset/datasetSchema` + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. }
@@ -1386,6 +1388,8 @@

Method Details

}, }, "name": "A String", # Dataset schema resource name. Format: `projects/{project}/locations/{location}/processors/{processor}/dataset/datasetSchema` + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. } updateMask: string, The update mask applies to the resource. @@ -1445,6 +1449,8 @@

Method Details

}, }, "name": "A String", # Dataset schema resource name. Format: `projects/{project}/locations/{location}/processors/{processor}/dataset/datasetSchema` + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. }
diff --git a/docs/dyn/drive_v3.files.accessproposals.html b/docs/dyn/drive_v3.files.accessproposals.html index 50e146f86f..9d600ec058 100644 --- a/docs/dyn/drive_v3.files.accessproposals.html +++ b/docs/dyn/drive_v3.files.accessproposals.html @@ -155,7 +155,7 @@

Method Details

ACTION_UNSPECIFIED - Unspecified action ACCEPT - The user accepts the proposal DENY - The user denies the proposal - role: string, Optional. The roles the approver has allowed, if any. (repeated) + role: string, Optional. The roles the approver has allowed, if any. Note: This field is required for the `ACCEPT` action. (repeated) sendNotification: boolean, Optional. Whether to send an email to the requester when the AccessProposal is denied or accepted. view: string, Optional. Indicates the view for this access proposal. This should only be set when the proposal belongs to a view. `published` is the only supported value. x__xgafv: string, V1 error format. diff --git a/docs/dyn/eventarc_v1.projects.locations.enrollments.html b/docs/dyn/eventarc_v1.projects.locations.enrollments.html index f6ae5b6a47..15b240e88a 100644 --- a/docs/dyn/eventarc_v1.projects.locations.enrollments.html +++ b/docs/dyn/eventarc_v1.projects.locations.enrollments.html @@ -77,9 +77,27 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Create a new Enrollment in a particular project and location.

+

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

+

Delete a single Enrollment.

+

+ get(name, x__xgafv=None)

+

Get a single Enrollment.

getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

+

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

+

List Enrollments.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update a single Enrollment.

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

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

@@ -92,6 +110,135 @@

Method Details

Close httplib2 connections.
+
+ create(parent, body=None, enrollmentId=None, validateOnly=None, x__xgafv=None) +
Create a new Enrollment in a particular project and location.
+
+Args:
+  parent: string, Required. The parent collection in which to add this enrollment. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An enrollment represents a subscription for messages on a particular message bus. It defines a matching criteria for messages on the bus and the subscriber endpoint where matched messages should be delivered.
+  "annotations": { # Optional. Resource annotations.
+    "a_key": "A String",
+  },
+  "celMatch": "A String", # Required. A CEL expression identifying which messages this enrollment applies to.
+  "createTime": "A String", # Output only. The creation time.
+  "destination": "A String", # Required. Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"
+  "displayName": "A String", # Optional. Resource display name.
+  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
+  "labels": { # Optional. Resource labels.
+    "a_key": "A String",
+  },
+  "messageBus": "A String", # Required. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
+  "name": "A String", # Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
+  "uid": "A String", # Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+  "updateTime": "A String", # Output only. The last-modified time.
+}
+
+  enrollmentId: string, Required. The user-provided ID to be assigned to the Enrollment. It should match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).
+  validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not post it.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, allowMissing=None, etag=None, validateOnly=None, x__xgafv=None) +
Delete a single Enrollment.
+
+Args:
+  name: string, Required. The name of the Enrollment to be deleted. (required)
+  allowMissing: boolean, Optional. If set to true, and the Enrollment is not found, the request will succeed but no action will be taken on the server.
+  etag: string, Optional. If provided, the Enrollment will only be deleted if the etag matches the current etag on the resource.
+  validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not post it.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Get a single Enrollment.
+
+Args:
+  name: string, Required. The name of the Enrollment to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An enrollment represents a subscription for messages on a particular message bus. It defines a matching criteria for messages on the bus and the subscriber endpoint where matched messages should be delivered.
+  "annotations": { # Optional. Resource annotations.
+    "a_key": "A String",
+  },
+  "celMatch": "A String", # Required. A CEL expression identifying which messages this enrollment applies to.
+  "createTime": "A String", # Output only. The creation time.
+  "destination": "A String", # Required. Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"
+  "displayName": "A String", # Optional. Resource display name.
+  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
+  "labels": { # Optional. Resource labels.
+    "a_key": "A String",
+  },
+  "messageBus": "A String", # Required. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
+  "name": "A String", # Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
+  "uid": "A String", # Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+  "updateTime": "A String", # Output only. The last-modified time.
+}
+
+
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
@@ -140,6 +287,124 @@ 

Method Details

}
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
List Enrollments.
+
+Args:
+  parent: string, Required. The parent collection to list triggers on. (required)
+  filter: string, Optional. The filter field that the list request will filter on. Possible filtersare described in https://google.aip.dev/160.
+  orderBy: string, Optional. The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a `desc` suffix; for example: `name desc, update_time`.
+  pageSize: integer, Optional. The maximum number of results to return on each page. Note: The service may send fewer.
+  pageToken: string, Optional. The page token; provide the value from the `next_page_token` field in a previous call to retrieve the subsequent page. When paginating, all other parameters provided must match the previous call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for the `ListEnrollments` method.
+  "enrollments": [ # The requested Enrollments, up to the number specified in `page_size`.
+    { # An enrollment represents a subscription for messages on a particular message bus. It defines a matching criteria for messages on the bus and the subscriber endpoint where matched messages should be delivered.
+      "annotations": { # Optional. Resource annotations.
+        "a_key": "A String",
+      },
+      "celMatch": "A String", # Required. A CEL expression identifying which messages this enrollment applies to.
+      "createTime": "A String", # Output only. The creation time.
+      "destination": "A String", # Required. Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"
+      "displayName": "A String", # Optional. Resource display name.
+      "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
+      "labels": { # Optional. Resource labels.
+        "a_key": "A String",
+      },
+      "messageBus": "A String", # Required. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
+      "name": "A String", # Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
+      "uid": "A String", # Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+      "updateTime": "A String", # Output only. The last-modified time.
+    },
+  ],
+  "nextPageToken": "A String", # A page token that can be sent to `ListEnrollments` to request the next page. If this is empty, then there are no more pages.
+  "unreachable": [ # Unreachable resources, if any.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, allowMissing=None, body=None, updateMask=None, validateOnly=None, x__xgafv=None) +
Update a single Enrollment.
+
+Args:
+  name: string, Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An enrollment represents a subscription for messages on a particular message bus. It defines a matching criteria for messages on the bus and the subscriber endpoint where matched messages should be delivered.
+  "annotations": { # Optional. Resource annotations.
+    "a_key": "A String",
+  },
+  "celMatch": "A String", # Required. A CEL expression identifying which messages this enrollment applies to.
+  "createTime": "A String", # Output only. The creation time.
+  "destination": "A String", # Required. Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"
+  "displayName": "A String", # Optional. Resource display name.
+  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
+  "labels": { # Optional. Resource labels.
+    "a_key": "A String",
+  },
+  "messageBus": "A String", # Required. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
+  "name": "A String", # Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
+  "uid": "A String", # Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+  "updateTime": "A String", # Output only. The last-modified time.
+}
+
+  allowMissing: boolean, Optional. If set to true, and the Enrollment is not found, a new Enrollment will be created. In this situation, `update_mask` is ignored.
+  updateMask: string, Optional. The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*".
+  validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not post it.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
diff --git a/docs/dyn/eventarc_v1.projects.locations.googleApiSources.html b/docs/dyn/eventarc_v1.projects.locations.googleApiSources.html
index 902661bbf2..84c574bd3d 100644
--- a/docs/dyn/eventarc_v1.projects.locations.googleApiSources.html
+++ b/docs/dyn/eventarc_v1.projects.locations.googleApiSources.html
@@ -77,9 +77,27 @@ 

Instance Methods

close()

Close httplib2 connections.

+

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

+

Create a new GoogleApiSource in a particular project and location.

+

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

+

Delete a single GoogleApiSource.

+

+ get(name, x__xgafv=None)

+

Get a single GoogleApiSource.

getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

+

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

+

List GoogleApiSources.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update a single GoogleApiSource.

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

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

@@ -92,6 +110,139 @@

Method Details

Close httplib2 connections.
+
+ create(parent, body=None, googleApiSourceId=None, validateOnly=None, x__xgafv=None) +
Create a new GoogleApiSource in a particular project and location.
+
+Args:
+  parent: string, Required. The parent collection in which to add this google api source. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A GoogleApiSource represents a subscription of 1P events from a MessageBus.
+  "annotations": { # Optional. Resource annotations.
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. The creation time.
+  "cryptoKeyName": "A String", # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
+  "destination": "A String", # Required. Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
+  "displayName": "A String", # Optional. Resource display name.
+  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
+  "labels": { # Optional. Resource labels.
+    "a_key": "A String",
+  },
+  "loggingConfig": { # The configuration for Platform Telemetry logging for Eventarc Avdvanced resources. # Optional. Config to control Platform logging for the GoogleApiSource.
+    "logSeverity": "A String", # Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
+  },
+  "name": "A String", # Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
+  "uid": "A String", # Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+  "updateTime": "A String", # Output only. The last-modified time.
+}
+
+  googleApiSourceId: string, Required. The user-provided ID to be assigned to the GoogleApiSource. It should match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).
+  validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not post it.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, allowMissing=None, etag=None, validateOnly=None, x__xgafv=None) +
Delete a single GoogleApiSource.
+
+Args:
+  name: string, Required. The name of the GoogleApiSource to be deleted. (required)
+  allowMissing: boolean, Optional. If set to true, and the MessageBus is not found, the request will succeed but no action will be taken on the server.
+  etag: string, Optional. If provided, the MessageBus will only be deleted if the etag matches the current etag on the resource.
+  validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not post it.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Get a single GoogleApiSource.
+
+Args:
+  name: string, Required. The name of the google api source to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A GoogleApiSource represents a subscription of 1P events from a MessageBus.
+  "annotations": { # Optional. Resource annotations.
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. The creation time.
+  "cryptoKeyName": "A String", # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
+  "destination": "A String", # Required. Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
+  "displayName": "A String", # Optional. Resource display name.
+  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
+  "labels": { # Optional. Resource labels.
+    "a_key": "A String",
+  },
+  "loggingConfig": { # The configuration for Platform Telemetry logging for Eventarc Avdvanced resources. # Optional. Config to control Platform logging for the GoogleApiSource.
+    "logSeverity": "A String", # Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
+  },
+  "name": "A String", # Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
+  "uid": "A String", # Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+  "updateTime": "A String", # Output only. The last-modified time.
+}
+
+
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
@@ -140,6 +291,128 @@ 

Method Details

}
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
List GoogleApiSources.
+
+Args:
+  parent: string, Required. The parent collection to list GoogleApiSources on. (required)
+  filter: string, Optional. The filter field that the list request will filter on. Possible filtersare described in https://google.aip.dev/160.
+  orderBy: string, Optional. The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a `desc` suffix; for example: `name desc, update_time`.
+  pageSize: integer, Optional. The maximum number of results to return on each page. Note: The service may send fewer.
+  pageToken: string, Optional. The page token; provide the value from the `next_page_token` field in a previous call to retrieve the subsequent page. When paginating, all other parameters provided must match the previous call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for the `ListGoogleApiSources` method.
+  "googleApiSources": [ # The requested GoogleApiSources, up to the number specified in `page_size`.
+    { # A GoogleApiSource represents a subscription of 1P events from a MessageBus.
+      "annotations": { # Optional. Resource annotations.
+        "a_key": "A String",
+      },
+      "createTime": "A String", # Output only. The creation time.
+      "cryptoKeyName": "A String", # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
+      "destination": "A String", # Required. Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
+      "displayName": "A String", # Optional. Resource display name.
+      "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
+      "labels": { # Optional. Resource labels.
+        "a_key": "A String",
+      },
+      "loggingConfig": { # The configuration for Platform Telemetry logging for Eventarc Avdvanced resources. # Optional. Config to control Platform logging for the GoogleApiSource.
+        "logSeverity": "A String", # Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
+      },
+      "name": "A String", # Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
+      "uid": "A String", # Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+      "updateTime": "A String", # Output only. The last-modified time.
+    },
+  ],
+  "nextPageToken": "A String", # A page token that can be sent to `ListMessageBusEnrollments` to request the next page. If this is empty, then there are no more pages.
+  "unreachable": [ # Unreachable resources, if any.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, allowMissing=None, body=None, updateMask=None, validateOnly=None, x__xgafv=None) +
Update a single GoogleApiSource.
+
+Args:
+  name: string, Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A GoogleApiSource represents a subscription of 1P events from a MessageBus.
+  "annotations": { # Optional. Resource annotations.
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. The creation time.
+  "cryptoKeyName": "A String", # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
+  "destination": "A String", # Required. Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
+  "displayName": "A String", # Optional. Resource display name.
+  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
+  "labels": { # Optional. Resource labels.
+    "a_key": "A String",
+  },
+  "loggingConfig": { # The configuration for Platform Telemetry logging for Eventarc Avdvanced resources. # Optional. Config to control Platform logging for the GoogleApiSource.
+    "logSeverity": "A String", # Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
+  },
+  "name": "A String", # Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
+  "uid": "A String", # Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+  "updateTime": "A String", # Output only. The last-modified time.
+}
+
+  allowMissing: boolean, Optional. If set to true, and the GoogleApiSource is not found, a new GoogleApiSource will be created. In this situation, `update_mask` is ignored.
+  updateMask: string, Optional. The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*".
+  validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not post it.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
diff --git a/docs/dyn/eventarc_v1.projects.locations.messageBuses.html b/docs/dyn/eventarc_v1.projects.locations.messageBuses.html
index f2cdbdc0f7..3eff9acba3 100644
--- a/docs/dyn/eventarc_v1.projects.locations.messageBuses.html
+++ b/docs/dyn/eventarc_v1.projects.locations.messageBuses.html
@@ -77,9 +77,33 @@ 

Instance Methods

close()

Close httplib2 connections.

+

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

+

Create a new MessageBus in a particular project and location.

+

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

+

Delete a single message bus.

+

+ get(name, x__xgafv=None)

+

Get a single MessageBus.

getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

+

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

+

List message buses.

+

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

+

List message bus enrollments.

+

+ listEnrollments_next()

+

Retrieves the next page of results.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update a single message bus.

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

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

@@ -92,6 +116,137 @@

Method Details

Close httplib2 connections.
+
+ create(parent, body=None, messageBusId=None, validateOnly=None, x__xgafv=None) +
Create a new MessageBus in a particular project and location.
+
+Args:
+  parent: string, Required. The parent collection in which to add this message bus. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # MessageBus for the messages flowing through the system. The admin has visibility and control over the messages being published and consumed and can restrict publishers and subscribers to only a subset of data available in the system by defining authorization policies.
+  "annotations": { # Optional. Resource annotations.
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. The creation time.
+  "cryptoKeyName": "A String", # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
+  "displayName": "A String", # Optional. Resource display name.
+  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
+  "labels": { # Optional. Resource labels.
+    "a_key": "A String",
+  },
+  "loggingConfig": { # The configuration for Platform Telemetry logging for Eventarc Avdvanced resources. # Optional. Config to control Platform logging for the Message Bus. This log configuration is applied to the Message Bus itself, and all the Enrollments attached to it.
+    "logSeverity": "A String", # Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
+  },
+  "name": "A String", # Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
+  "uid": "A String", # Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+  "updateTime": "A String", # Output only. The last-modified time.
+}
+
+  messageBusId: string, Required. The user-provided ID to be assigned to the MessageBus. It should match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$)
+  validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not post it.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, allowMissing=None, etag=None, validateOnly=None, x__xgafv=None) +
Delete a single message bus.
+
+Args:
+  name: string, Required. The name of the MessageBus to be deleted. (required)
+  allowMissing: boolean, Optional. If set to true, and the MessageBus is not found, the request will succeed but no action will be taken on the server.
+  etag: string, Optional. If provided, the MessageBus will only be deleted if the etag matches the current etag on the resource.
+  validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not post it.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Get a single MessageBus.
+
+Args:
+  name: string, Required. The name of the message bus to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # MessageBus for the messages flowing through the system. The admin has visibility and control over the messages being published and consumed and can restrict publishers and subscribers to only a subset of data available in the system by defining authorization policies.
+  "annotations": { # Optional. Resource annotations.
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. The creation time.
+  "cryptoKeyName": "A String", # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
+  "displayName": "A String", # Optional. Resource display name.
+  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
+  "labels": { # Optional. Resource labels.
+    "a_key": "A String",
+  },
+  "loggingConfig": { # The configuration for Platform Telemetry logging for Eventarc Avdvanced resources. # Optional. Config to control Platform logging for the Message Bus. This log configuration is applied to the Message Bus itself, and all the Enrollments attached to it.
+    "logSeverity": "A String", # Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
+  },
+  "name": "A String", # Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
+  "uid": "A String", # Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+  "updateTime": "A String", # Output only. The last-modified time.
+}
+
+
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
@@ -140,6 +295,167 @@ 

Method Details

}
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
List message buses.
+
+Args:
+  parent: string, Required. The parent collection to list triggers on. (required)
+  filter: string, Optional. The filter field that the list request will filter on. Possible filtersare described in https://google.aip.dev/160.
+  orderBy: string, Optional. The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a `desc` suffix; for example: `name desc, update_time`.
+  pageSize: integer, Optional. The maximum number of results to return on each page. Note: The service may send fewer.
+  pageToken: string, Optional. The page token; provide the value from the `next_page_token` field in a previous call to retrieve the subsequent page. When paginating, all other parameters provided must match the previous call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for the `ListMessageBuses` method.
+  "messageBuses": [ # The requested message buses, up to the number specified in `page_size`.
+    { # MessageBus for the messages flowing through the system. The admin has visibility and control over the messages being published and consumed and can restrict publishers and subscribers to only a subset of data available in the system by defining authorization policies.
+      "annotations": { # Optional. Resource annotations.
+        "a_key": "A String",
+      },
+      "createTime": "A String", # Output only. The creation time.
+      "cryptoKeyName": "A String", # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
+      "displayName": "A String", # Optional. Resource display name.
+      "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
+      "labels": { # Optional. Resource labels.
+        "a_key": "A String",
+      },
+      "loggingConfig": { # The configuration for Platform Telemetry logging for Eventarc Avdvanced resources. # Optional. Config to control Platform logging for the Message Bus. This log configuration is applied to the Message Bus itself, and all the Enrollments attached to it.
+        "logSeverity": "A String", # Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
+      },
+      "name": "A String", # Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
+      "uid": "A String", # Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+      "updateTime": "A String", # Output only. The last-modified time.
+    },
+  ],
+  "nextPageToken": "A String", # A page token that can be sent to `ListMessageBuses` to request the next page. If this is empty, then there are no more pages.
+  "unreachable": [ # Unreachable resources, if any.
+    "A String",
+  ],
+}
+
+ +
+ listEnrollments(parent, pageSize=None, pageToken=None, x__xgafv=None) +
List message bus enrollments.
+
+Args:
+  parent: string, Required. The parent message bus to list enrollments on. (required)
+  pageSize: integer, Optional. The maximum number of results to return on each page. Note: The service may send fewer.
+  pageToken: string, Optional. The page token; provide the value from the `next_page_token` field in a previous call to retrieve the subsequent page. When paginating, all other parameters provided must match the previous call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for the `ListMessageBusEnrollments` method.`
+  "enrollments": [ # The requested enrollments, up to the number specified in `page_size`.
+    "A String",
+  ],
+  "nextPageToken": "A String", # A page token that can be sent to `ListMessageBusEnrollments` to request the next page. If this is empty, then there are no more pages.
+  "unreachable": [ # Unreachable resources, if any.
+    "A String",
+  ],
+}
+
+ +
+ listEnrollments_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, allowMissing=None, body=None, updateMask=None, validateOnly=None, x__xgafv=None) +
Update a single message bus.
+
+Args:
+  name: string, Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # MessageBus for the messages flowing through the system. The admin has visibility and control over the messages being published and consumed and can restrict publishers and subscribers to only a subset of data available in the system by defining authorization policies.
+  "annotations": { # Optional. Resource annotations.
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. The creation time.
+  "cryptoKeyName": "A String", # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
+  "displayName": "A String", # Optional. Resource display name.
+  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
+  "labels": { # Optional. Resource labels.
+    "a_key": "A String",
+  },
+  "loggingConfig": { # The configuration for Platform Telemetry logging for Eventarc Avdvanced resources. # Optional. Config to control Platform logging for the Message Bus. This log configuration is applied to the Message Bus itself, and all the Enrollments attached to it.
+    "logSeverity": "A String", # Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
+  },
+  "name": "A String", # Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
+  "uid": "A String", # Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+  "updateTime": "A String", # Output only. The last-modified time.
+}
+
+  allowMissing: boolean, Optional. If set to true, and the MessageBus is not found, a new MessageBus will be created. In this situation, `update_mask` is ignored.
+  updateMask: string, Optional. The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*".
+  validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not post it.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
diff --git a/docs/dyn/eventarc_v1.projects.locations.pipelines.html b/docs/dyn/eventarc_v1.projects.locations.pipelines.html
index f327401288..29ddbfd79c 100644
--- a/docs/dyn/eventarc_v1.projects.locations.pipelines.html
+++ b/docs/dyn/eventarc_v1.projects.locations.pipelines.html
@@ -77,9 +77,27 @@ 

Instance Methods

close()

Close httplib2 connections.

+

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

+

Create a new Pipeline in a particular project and location.

+

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

+

Delete a single pipeline.

+

+ get(name, x__xgafv=None)

+

Get a single Pipeline.

getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

+

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

+

List pipelines.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update a single pipeline.

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

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

@@ -92,6 +110,249 @@

Method Details

Close httplib2 connections.
+
+ create(parent, body=None, pipelineId=None, validateOnly=None, x__xgafv=None) +
Create a new Pipeline in a particular project and location.
+
+Args:
+  parent: string, Required. The parent collection in which to add this pipeline. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A representation of the Pipeline resource.
+  "annotations": { # Optional. User-defined annotations. See https://google.aip.dev/128#annotations.
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. The creation time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
+  "cryptoKeyName": "A String", # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt the event data. If not set, an internal Google-owned key will be used to encrypt messages. It must match the pattern "projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}".
+  "destinations": [ # Required. List of destinations to which messages will be forwarded. Currently, exactly one destination is supported per Pipeline.
+    { # Represents a target of an invocation over HTTP.
+      "authenticationConfig": { # Represents a config used to authenticate message requests. # Optional. An authentication config used to authenticate message requests, such that destinations can verify the source. For example, this can be used with private GCP destinations that require GCP credentials to access like Cloud Run. This field is optional and should be set only by users interested in authenticated push
+        "googleOidc": { # Represents a config used to authenticate with a Google OIDC token using a GCP service account. Use this authentication method to invoke your Cloud Run and Cloud Functions destinations or HTTP endpoints that support Google OIDC. # Optional. This authenticate method will apply Google OIDC tokens signed by a GCP service account to the requests.
+          "audience": "A String", # Optional. Audience to be used to generate the OIDC Token. The audience claim identifies the recipient that the JWT is intended for. If unspecified, the destination URI will be used.
+          "serviceAccount": "A String", # Required. Service account email used to generate the OIDC Token. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow the Pipeline to create OpenID tokens for authenticated requests.
+        },
+        "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # Optional. If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
+          "scope": "A String", # Optional. OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
+          "serviceAccount": "A String", # Required. Service account email used to generate the [OAuth token](https://developers.google.com/identity/protocols/OAuth2). The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow Pipeline to create OAuth2 tokens for authenticated requests.
+        },
+      },
+      "httpEndpoint": { # Represents a HTTP endpoint destination. # Optional. An HTTP endpoint destination described by an URI. If a DNS FQDN is provided as the endpoint, Pipeline will create a peering zone to the consumer VPC and forward DNS requests to the VPC specified by network config to resolve the service endpoint. See: https://cloud.google.com/dns/docs/zones/zones-overview#peering_zones
+        "messageBindingTemplate": "A String", # Optional. The CEL expression used to construct a new HTTP request to be sent to the final destination. The result of the CEL expression must be a map of key/value pairs such that: - If a map named `headers` exists on the result of the expression, then its key/value pairs are directly mapped to the HTTP request headers. The headers values are constructed from the corresponding value type’s canonical representation. If the `headers` field doesn’t exist then the resulting HTTP request will be without headers. - If a field named `body` exists on the result of the expression then its value is directly mapped to the body of the request. If the value of the `body` field is of type bytes or string then it is used for the HTTP request body as-is, with no conversion. If the body field is of any other type then it is converted to a JSON string. If the body field doesn’t exist then the resulting HTTP request will be without a body. - Any other fields in the resulting expression will be ignored. The CEL expression may access the incoming CloudEvent message in its definition, as follows: - The `data` field of the incoming CloudEvent message can be accessed using the `message.data` value. - Each attribute of the incoming CloudEvent message can be accessed using the `message.` value, where is replaced with the name of the attribute. Headers added to the request by previous filters in the chain can be accessed in the CEL expression using the `headers` variable. The `headers` variable defines a map of key/value pairs corresponding to the HTTP headers added by previous mediation steps and not the headers present on the original incoming request. For example, the following CEL expression can be used to construct a Headers-only HTTP request by adding an additional header to the headers added by previous mediations in the Pipeline: ``` {"headers": headers.merge({"new-header-key": "new-header-value"})} ``` Additionally, the following CEL extension functions are provided for use in this CEL expression: - toBase64Url: map.toBase64Url() -> string - Converts a CelValue to a base64url encoded string - toJsonString: map.toJsonString() -> string - Converts a CelValue to a JSON string - merge: map1.merge(map2) -> map3 - Merges the passed CEL map with the existing CEL map the function is applied to. - If the same key exists in both maps, if the key's value is type map both maps are merged else the value from the passed map is used. - toMap: list(map).toMap() -> map - Converts a CEL list of CEL maps to a single CEL map - toDestinationPayloadFormat(): message.data.toDestinationPayloadFormat() -> string or bytes - Converts the message data to the destination payload format specified in Pipeline.Destination.output_payload_format - This function is meant to be applied to the message.data field. - If the destination payload format is not set, the function will return the message data unchanged. - toCloudEventJsonWithPayloadFormat: message.toCloudEventJsonWithPayloadFormat() -> map - Converts a message to the corresponding structure of JSON format for CloudEvents - This function applies toDestinationPayloadFormat() to the message data. It also sets the corresponding datacontenttype of the CloudEvent, as indicated by Pipeline.Destination.output_payload_format. If no output_payload_format is set it will use the existing datacontenttype on the CloudEvent if present, else leave datacontenttype absent. - This function expects that the content of the message will adhere to the standard CloudEvent format. If it doesn’t then this function will fail. - The result is a CEL map that corresponds to the JSON representation of the CloudEvent. To convert that data to a JSON string it can be chained with the toJsonString function. If a binding is not specified here, by default the message is treated as a CloudEvent and is mapped to the HTTP request according to the CloudEvent HTTP Protocol Binding Binary Content Mode. The Pipeline converts the data field of the message to the format provided in Pipeline.Destination.output_payload_format and maps it to the body field of the result. It also sets the corresponding Content-Type header to the output_payload_format type. If the Pipeline.Destination.output_payload_format is not set, then the Pipeline will treat the data field of the message as opaque binary data and attach it to the request body as bytes. In this case the Content-type header will be set to the value of the datacontenttype attribute set on the incoming CloudEvent message if present and the `application/octet-stream` MIME type otherwise. The Pipeline expects that the content of the message will adhere to the standard CloudEvent format. If it doesn’t then the outgoing message request may fail with a persistent error.
+        "uri": "A String", # Required. The URI of the HTTP enpdoint. The value must be a RFC2396 URI string. Examples: `http://10.10.10.8:80/route`, `http://svc.us-central1.p.local:8080/`. Only HTTP and HTTPS protocols are supported. The host can be either a static IP addressable from the VPC specified by the network config, or an internal DNS hostname of the service resolvable via Cloud DNS.
+      },
+      "messageBus": "A String", # Optional. The resource name of the Message Bus to which events should be published. The Message Bus resource should exist in the same project as the Pipeline. Format: `projects/{project}/locations/{location}/messageBuses/{message_bus}`
+      "networkConfig": { # Represents a network config to be used for destination resolution and connectivity. # Optional. Network config is used to configure how Pipeline resolves and connects to a destination.
+        "networkAttachment": "A String", # Required. Name of the NetworkAttachment that allows access to the consumer VPC. Format: `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}`
+      },
+      "outputPayloadFormat": { # Represents the format of message data. # Optional. The message format before it is delivered to the destination. If not set, the message will be delivered in the format it was originally delivered to the Pipeline. This field can only be set if Pipeline.input_payload_format is also set.
+        "avro": { # The format of an AVRO message payload. # Optional. Avro format.
+          "schemaDefinition": "A String", # Optional. The entire schema definition is stored in this field.
+        },
+        "json": { # The format of a JSON message payload. # Optional. JSON format.
+        },
+        "protobuf": { # The format of a Protobuf message payload. # Optional. Protobuf format.
+          "schemaDefinition": "A String", # Optional. The entire schema definition is stored in this field.
+        },
+      },
+      "topic": "A String", # Optional. The resource name of the Pub/Sub topic to which events should be published. Format: `projects/{project}/locations/{location}/topics/{topic}`
+      "workflow": "A String", # Optional. The resource name of the Workflow whose Executions are triggered by the events. The Workflow resource should be deployed in the same project as the Pipeline. Format: `projects/{project}/locations/{location}/workflows/{workflow}`
+    },
+  ],
+  "displayName": "A String", # Optional. Display name of resource.
+  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on create requests to ensure that the client has an up-to-date value before proceeding.
+  "inputPayloadFormat": { # Represents the format of message data. # Optional. The payload format expected for the messages received by the Pipeline. If input_payload_format is set then any messages not matching this format will be treated as persistent errors. If input_payload_format is not set, then the message data will be treated as an opaque binary and no output format can be set on the Pipeline through the Pipeline.Destination.output_payload_format field. Any Mediations on the Pipeline that involve access to the data field will fail as persistent errors.
+    "avro": { # The format of an AVRO message payload. # Optional. Avro format.
+      "schemaDefinition": "A String", # Optional. The entire schema definition is stored in this field.
+    },
+    "json": { # The format of a JSON message payload. # Optional. JSON format.
+    },
+    "protobuf": { # The format of a Protobuf message payload. # Optional. Protobuf format.
+      "schemaDefinition": "A String", # Optional. The entire schema definition is stored in this field.
+    },
+  },
+  "labels": { # Optional. User labels attached to the Pipeline that can be used to group resources. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
+    "a_key": "A String",
+  },
+  "loggingConfig": { # The configuration for Platform Telemetry logging for Eventarc Avdvanced resources. # Optional. Config to control Platform Logging for Pipelines.
+    "logSeverity": "A String", # Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
+  },
+  "mediations": [ # Optional. List of mediation operations to be performed on the message. Currently, only one Transformation operation is allowed in each Pipeline.
+    { # Mediation defines different ways to modify the Pipeline.
+      "transformation": { # Transformation defines the way to transform an incoming message. # Optional. How the Pipeline is to transform messages
+        "transformationTemplate": "A String", # Optional. The template to apply to transform messages.
+      },
+    },
+  ],
+  "name": "A String", # Identifier. The resource name of the Pipeline. Must be unique within the location of the project and must be in `projects/{project}/locations/{location}/pipelines/{pipeline}` format.
+  "retryPolicy": { # The retry policy configuration for the Pipeline. The pipeline exponentially backs off in case the destination is non responsive or returns a retryable error code. The default semantics are as follows: The backoff starts with a 5 second delay and doubles the delay after each failed attempt (10 seconds, 20 seconds, 40 seconds, etc.). The delay is capped at 60 seconds by default. Please note that if you set the min_retry_delay and max_retry_delay fields to the same value this will make the duration between retries constant. # Optional. The retry policy to use in the pipeline.
+    "maxAttempts": 42, # Optional. The maximum number of delivery attempts for any message. The value must be between 1 and 100. The default value for this field is 5.
+    "maxRetryDelay": "A String", # Optional. The maximum amount of seconds to wait between retry attempts. The value must be between 0 and 600. The default value for this field is 60.
+    "minRetryDelay": "A String", # Optional. The minimum amount of seconds to wait between retry attempts. The value must be between 0 and 600. The default value for this field is 5.
+  },
+  "uid": "A String", # Output only. Server-assigned unique identifier for the Pipeline. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+  "updateTime": "A String", # Output only. The last-modified time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
+}
+
+  pipelineId: string, Required. The user-provided ID to be assigned to the Pipeline.
+  validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not post it.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, allowMissing=None, etag=None, validateOnly=None, x__xgafv=None) +
Delete a single pipeline.
+
+Args:
+  name: string, Required. The name of the Pipeline to be deleted. (required)
+  allowMissing: boolean, Optional. If set to true, and the Pipeline is not found, the request will succeed but no action will be taken on the server.
+  etag: string, Optional. If provided, the Pipeline will only be deleted if the etag matches the current etag on the resource.
+  validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not post it.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Get a single Pipeline.
+
+Args:
+  name: string, Required. The name of the pipeline to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A representation of the Pipeline resource.
+  "annotations": { # Optional. User-defined annotations. See https://google.aip.dev/128#annotations.
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. The creation time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
+  "cryptoKeyName": "A String", # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt the event data. If not set, an internal Google-owned key will be used to encrypt messages. It must match the pattern "projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}".
+  "destinations": [ # Required. List of destinations to which messages will be forwarded. Currently, exactly one destination is supported per Pipeline.
+    { # Represents a target of an invocation over HTTP.
+      "authenticationConfig": { # Represents a config used to authenticate message requests. # Optional. An authentication config used to authenticate message requests, such that destinations can verify the source. For example, this can be used with private GCP destinations that require GCP credentials to access like Cloud Run. This field is optional and should be set only by users interested in authenticated push
+        "googleOidc": { # Represents a config used to authenticate with a Google OIDC token using a GCP service account. Use this authentication method to invoke your Cloud Run and Cloud Functions destinations or HTTP endpoints that support Google OIDC. # Optional. This authenticate method will apply Google OIDC tokens signed by a GCP service account to the requests.
+          "audience": "A String", # Optional. Audience to be used to generate the OIDC Token. The audience claim identifies the recipient that the JWT is intended for. If unspecified, the destination URI will be used.
+          "serviceAccount": "A String", # Required. Service account email used to generate the OIDC Token. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow the Pipeline to create OpenID tokens for authenticated requests.
+        },
+        "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # Optional. If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
+          "scope": "A String", # Optional. OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
+          "serviceAccount": "A String", # Required. Service account email used to generate the [OAuth token](https://developers.google.com/identity/protocols/OAuth2). The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow Pipeline to create OAuth2 tokens for authenticated requests.
+        },
+      },
+      "httpEndpoint": { # Represents a HTTP endpoint destination. # Optional. An HTTP endpoint destination described by an URI. If a DNS FQDN is provided as the endpoint, Pipeline will create a peering zone to the consumer VPC and forward DNS requests to the VPC specified by network config to resolve the service endpoint. See: https://cloud.google.com/dns/docs/zones/zones-overview#peering_zones
+        "messageBindingTemplate": "A String", # Optional. The CEL expression used to construct a new HTTP request to be sent to the final destination. The result of the CEL expression must be a map of key/value pairs such that: - If a map named `headers` exists on the result of the expression, then its key/value pairs are directly mapped to the HTTP request headers. The headers values are constructed from the corresponding value type’s canonical representation. If the `headers` field doesn’t exist then the resulting HTTP request will be without headers. - If a field named `body` exists on the result of the expression then its value is directly mapped to the body of the request. If the value of the `body` field is of type bytes or string then it is used for the HTTP request body as-is, with no conversion. If the body field is of any other type then it is converted to a JSON string. If the body field doesn’t exist then the resulting HTTP request will be without a body. - Any other fields in the resulting expression will be ignored. The CEL expression may access the incoming CloudEvent message in its definition, as follows: - The `data` field of the incoming CloudEvent message can be accessed using the `message.data` value. - Each attribute of the incoming CloudEvent message can be accessed using the `message.` value, where is replaced with the name of the attribute. Headers added to the request by previous filters in the chain can be accessed in the CEL expression using the `headers` variable. The `headers` variable defines a map of key/value pairs corresponding to the HTTP headers added by previous mediation steps and not the headers present on the original incoming request. For example, the following CEL expression can be used to construct a Headers-only HTTP request by adding an additional header to the headers added by previous mediations in the Pipeline: ``` {"headers": headers.merge({"new-header-key": "new-header-value"})} ``` Additionally, the following CEL extension functions are provided for use in this CEL expression: - toBase64Url: map.toBase64Url() -> string - Converts a CelValue to a base64url encoded string - toJsonString: map.toJsonString() -> string - Converts a CelValue to a JSON string - merge: map1.merge(map2) -> map3 - Merges the passed CEL map with the existing CEL map the function is applied to. - If the same key exists in both maps, if the key's value is type map both maps are merged else the value from the passed map is used. - toMap: list(map).toMap() -> map - Converts a CEL list of CEL maps to a single CEL map - toDestinationPayloadFormat(): message.data.toDestinationPayloadFormat() -> string or bytes - Converts the message data to the destination payload format specified in Pipeline.Destination.output_payload_format - This function is meant to be applied to the message.data field. - If the destination payload format is not set, the function will return the message data unchanged. - toCloudEventJsonWithPayloadFormat: message.toCloudEventJsonWithPayloadFormat() -> map - Converts a message to the corresponding structure of JSON format for CloudEvents - This function applies toDestinationPayloadFormat() to the message data. It also sets the corresponding datacontenttype of the CloudEvent, as indicated by Pipeline.Destination.output_payload_format. If no output_payload_format is set it will use the existing datacontenttype on the CloudEvent if present, else leave datacontenttype absent. - This function expects that the content of the message will adhere to the standard CloudEvent format. If it doesn’t then this function will fail. - The result is a CEL map that corresponds to the JSON representation of the CloudEvent. To convert that data to a JSON string it can be chained with the toJsonString function. If a binding is not specified here, by default the message is treated as a CloudEvent and is mapped to the HTTP request according to the CloudEvent HTTP Protocol Binding Binary Content Mode. The Pipeline converts the data field of the message to the format provided in Pipeline.Destination.output_payload_format and maps it to the body field of the result. It also sets the corresponding Content-Type header to the output_payload_format type. If the Pipeline.Destination.output_payload_format is not set, then the Pipeline will treat the data field of the message as opaque binary data and attach it to the request body as bytes. In this case the Content-type header will be set to the value of the datacontenttype attribute set on the incoming CloudEvent message if present and the `application/octet-stream` MIME type otherwise. The Pipeline expects that the content of the message will adhere to the standard CloudEvent format. If it doesn’t then the outgoing message request may fail with a persistent error.
+        "uri": "A String", # Required. The URI of the HTTP enpdoint. The value must be a RFC2396 URI string. Examples: `http://10.10.10.8:80/route`, `http://svc.us-central1.p.local:8080/`. Only HTTP and HTTPS protocols are supported. The host can be either a static IP addressable from the VPC specified by the network config, or an internal DNS hostname of the service resolvable via Cloud DNS.
+      },
+      "messageBus": "A String", # Optional. The resource name of the Message Bus to which events should be published. The Message Bus resource should exist in the same project as the Pipeline. Format: `projects/{project}/locations/{location}/messageBuses/{message_bus}`
+      "networkConfig": { # Represents a network config to be used for destination resolution and connectivity. # Optional. Network config is used to configure how Pipeline resolves and connects to a destination.
+        "networkAttachment": "A String", # Required. Name of the NetworkAttachment that allows access to the consumer VPC. Format: `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}`
+      },
+      "outputPayloadFormat": { # Represents the format of message data. # Optional. The message format before it is delivered to the destination. If not set, the message will be delivered in the format it was originally delivered to the Pipeline. This field can only be set if Pipeline.input_payload_format is also set.
+        "avro": { # The format of an AVRO message payload. # Optional. Avro format.
+          "schemaDefinition": "A String", # Optional. The entire schema definition is stored in this field.
+        },
+        "json": { # The format of a JSON message payload. # Optional. JSON format.
+        },
+        "protobuf": { # The format of a Protobuf message payload. # Optional. Protobuf format.
+          "schemaDefinition": "A String", # Optional. The entire schema definition is stored in this field.
+        },
+      },
+      "topic": "A String", # Optional. The resource name of the Pub/Sub topic to which events should be published. Format: `projects/{project}/locations/{location}/topics/{topic}`
+      "workflow": "A String", # Optional. The resource name of the Workflow whose Executions are triggered by the events. The Workflow resource should be deployed in the same project as the Pipeline. Format: `projects/{project}/locations/{location}/workflows/{workflow}`
+    },
+  ],
+  "displayName": "A String", # Optional. Display name of resource.
+  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on create requests to ensure that the client has an up-to-date value before proceeding.
+  "inputPayloadFormat": { # Represents the format of message data. # Optional. The payload format expected for the messages received by the Pipeline. If input_payload_format is set then any messages not matching this format will be treated as persistent errors. If input_payload_format is not set, then the message data will be treated as an opaque binary and no output format can be set on the Pipeline through the Pipeline.Destination.output_payload_format field. Any Mediations on the Pipeline that involve access to the data field will fail as persistent errors.
+    "avro": { # The format of an AVRO message payload. # Optional. Avro format.
+      "schemaDefinition": "A String", # Optional. The entire schema definition is stored in this field.
+    },
+    "json": { # The format of a JSON message payload. # Optional. JSON format.
+    },
+    "protobuf": { # The format of a Protobuf message payload. # Optional. Protobuf format.
+      "schemaDefinition": "A String", # Optional. The entire schema definition is stored in this field.
+    },
+  },
+  "labels": { # Optional. User labels attached to the Pipeline that can be used to group resources. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
+    "a_key": "A String",
+  },
+  "loggingConfig": { # The configuration for Platform Telemetry logging for Eventarc Avdvanced resources. # Optional. Config to control Platform Logging for Pipelines.
+    "logSeverity": "A String", # Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
+  },
+  "mediations": [ # Optional. List of mediation operations to be performed on the message. Currently, only one Transformation operation is allowed in each Pipeline.
+    { # Mediation defines different ways to modify the Pipeline.
+      "transformation": { # Transformation defines the way to transform an incoming message. # Optional. How the Pipeline is to transform messages
+        "transformationTemplate": "A String", # Optional. The template to apply to transform messages.
+      },
+    },
+  ],
+  "name": "A String", # Identifier. The resource name of the Pipeline. Must be unique within the location of the project and must be in `projects/{project}/locations/{location}/pipelines/{pipeline}` format.
+  "retryPolicy": { # The retry policy configuration for the Pipeline. The pipeline exponentially backs off in case the destination is non responsive or returns a retryable error code. The default semantics are as follows: The backoff starts with a 5 second delay and doubles the delay after each failed attempt (10 seconds, 20 seconds, 40 seconds, etc.). The delay is capped at 60 seconds by default. Please note that if you set the min_retry_delay and max_retry_delay fields to the same value this will make the duration between retries constant. # Optional. The retry policy to use in the pipeline.
+    "maxAttempts": 42, # Optional. The maximum number of delivery attempts for any message. The value must be between 1 and 100. The default value for this field is 5.
+    "maxRetryDelay": "A String", # Optional. The maximum amount of seconds to wait between retry attempts. The value must be between 0 and 600. The default value for this field is 60.
+    "minRetryDelay": "A String", # Optional. The minimum amount of seconds to wait between retry attempts. The value must be between 0 and 600. The default value for this field is 5.
+  },
+  "uid": "A String", # Output only. Server-assigned unique identifier for the Pipeline. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+  "updateTime": "A String", # Output only. The last-modified time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
+}
+
+
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
@@ -140,6 +401,238 @@ 

Method Details

}
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
List pipelines.
+
+Args:
+  parent: string, Required. The parent collection to list pipelines on. (required)
+  filter: string, Optional. The filter field that the list request will filter on. Possible filters are described in https://google.aip.dev/160.
+  orderBy: string, Optional. The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a `desc` suffix; for example: `name desc, update_time`.
+  pageSize: integer, Optional. The maximum number of results to return on each page. Note: The service may send fewer.
+  pageToken: string, Optional. The page token; provide the value from the `next_page_token` field in a previous call to retrieve the subsequent page. When paginating, all other parameters provided must match the previous call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for the ListPipelines method.
+  "nextPageToken": "A String", # A page token that can be sent to `ListPipelines` to request the next page. If this is empty, then there are no more pages.
+  "pipelines": [ # The requested pipelines, up to the number specified in `page_size`.
+    { # A representation of the Pipeline resource.
+      "annotations": { # Optional. User-defined annotations. See https://google.aip.dev/128#annotations.
+        "a_key": "A String",
+      },
+      "createTime": "A String", # Output only. The creation time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
+      "cryptoKeyName": "A String", # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt the event data. If not set, an internal Google-owned key will be used to encrypt messages. It must match the pattern "projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}".
+      "destinations": [ # Required. List of destinations to which messages will be forwarded. Currently, exactly one destination is supported per Pipeline.
+        { # Represents a target of an invocation over HTTP.
+          "authenticationConfig": { # Represents a config used to authenticate message requests. # Optional. An authentication config used to authenticate message requests, such that destinations can verify the source. For example, this can be used with private GCP destinations that require GCP credentials to access like Cloud Run. This field is optional and should be set only by users interested in authenticated push
+            "googleOidc": { # Represents a config used to authenticate with a Google OIDC token using a GCP service account. Use this authentication method to invoke your Cloud Run and Cloud Functions destinations or HTTP endpoints that support Google OIDC. # Optional. This authenticate method will apply Google OIDC tokens signed by a GCP service account to the requests.
+              "audience": "A String", # Optional. Audience to be used to generate the OIDC Token. The audience claim identifies the recipient that the JWT is intended for. If unspecified, the destination URI will be used.
+              "serviceAccount": "A String", # Required. Service account email used to generate the OIDC Token. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow the Pipeline to create OpenID tokens for authenticated requests.
+            },
+            "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # Optional. If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
+              "scope": "A String", # Optional. OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
+              "serviceAccount": "A String", # Required. Service account email used to generate the [OAuth token](https://developers.google.com/identity/protocols/OAuth2). The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow Pipeline to create OAuth2 tokens for authenticated requests.
+            },
+          },
+          "httpEndpoint": { # Represents a HTTP endpoint destination. # Optional. An HTTP endpoint destination described by an URI. If a DNS FQDN is provided as the endpoint, Pipeline will create a peering zone to the consumer VPC and forward DNS requests to the VPC specified by network config to resolve the service endpoint. See: https://cloud.google.com/dns/docs/zones/zones-overview#peering_zones
+            "messageBindingTemplate": "A String", # Optional. The CEL expression used to construct a new HTTP request to be sent to the final destination. The result of the CEL expression must be a map of key/value pairs such that: - If a map named `headers` exists on the result of the expression, then its key/value pairs are directly mapped to the HTTP request headers. The headers values are constructed from the corresponding value type’s canonical representation. If the `headers` field doesn’t exist then the resulting HTTP request will be without headers. - If a field named `body` exists on the result of the expression then its value is directly mapped to the body of the request. If the value of the `body` field is of type bytes or string then it is used for the HTTP request body as-is, with no conversion. If the body field is of any other type then it is converted to a JSON string. If the body field doesn’t exist then the resulting HTTP request will be without a body. - Any other fields in the resulting expression will be ignored. The CEL expression may access the incoming CloudEvent message in its definition, as follows: - The `data` field of the incoming CloudEvent message can be accessed using the `message.data` value. - Each attribute of the incoming CloudEvent message can be accessed using the `message.` value, where is replaced with the name of the attribute. Headers added to the request by previous filters in the chain can be accessed in the CEL expression using the `headers` variable. The `headers` variable defines a map of key/value pairs corresponding to the HTTP headers added by previous mediation steps and not the headers present on the original incoming request. For example, the following CEL expression can be used to construct a Headers-only HTTP request by adding an additional header to the headers added by previous mediations in the Pipeline: ``` {"headers": headers.merge({"new-header-key": "new-header-value"})} ``` Additionally, the following CEL extension functions are provided for use in this CEL expression: - toBase64Url: map.toBase64Url() -> string - Converts a CelValue to a base64url encoded string - toJsonString: map.toJsonString() -> string - Converts a CelValue to a JSON string - merge: map1.merge(map2) -> map3 - Merges the passed CEL map with the existing CEL map the function is applied to. - If the same key exists in both maps, if the key's value is type map both maps are merged else the value from the passed map is used. - toMap: list(map).toMap() -> map - Converts a CEL list of CEL maps to a single CEL map - toDestinationPayloadFormat(): message.data.toDestinationPayloadFormat() -> string or bytes - Converts the message data to the destination payload format specified in Pipeline.Destination.output_payload_format - This function is meant to be applied to the message.data field. - If the destination payload format is not set, the function will return the message data unchanged. - toCloudEventJsonWithPayloadFormat: message.toCloudEventJsonWithPayloadFormat() -> map - Converts a message to the corresponding structure of JSON format for CloudEvents - This function applies toDestinationPayloadFormat() to the message data. It also sets the corresponding datacontenttype of the CloudEvent, as indicated by Pipeline.Destination.output_payload_format. If no output_payload_format is set it will use the existing datacontenttype on the CloudEvent if present, else leave datacontenttype absent. - This function expects that the content of the message will adhere to the standard CloudEvent format. If it doesn’t then this function will fail. - The result is a CEL map that corresponds to the JSON representation of the CloudEvent. To convert that data to a JSON string it can be chained with the toJsonString function. If a binding is not specified here, by default the message is treated as a CloudEvent and is mapped to the HTTP request according to the CloudEvent HTTP Protocol Binding Binary Content Mode. The Pipeline converts the data field of the message to the format provided in Pipeline.Destination.output_payload_format and maps it to the body field of the result. It also sets the corresponding Content-Type header to the output_payload_format type. If the Pipeline.Destination.output_payload_format is not set, then the Pipeline will treat the data field of the message as opaque binary data and attach it to the request body as bytes. In this case the Content-type header will be set to the value of the datacontenttype attribute set on the incoming CloudEvent message if present and the `application/octet-stream` MIME type otherwise. The Pipeline expects that the content of the message will adhere to the standard CloudEvent format. If it doesn’t then the outgoing message request may fail with a persistent error.
+            "uri": "A String", # Required. The URI of the HTTP enpdoint. The value must be a RFC2396 URI string. Examples: `http://10.10.10.8:80/route`, `http://svc.us-central1.p.local:8080/`. Only HTTP and HTTPS protocols are supported. The host can be either a static IP addressable from the VPC specified by the network config, or an internal DNS hostname of the service resolvable via Cloud DNS.
+          },
+          "messageBus": "A String", # Optional. The resource name of the Message Bus to which events should be published. The Message Bus resource should exist in the same project as the Pipeline. Format: `projects/{project}/locations/{location}/messageBuses/{message_bus}`
+          "networkConfig": { # Represents a network config to be used for destination resolution and connectivity. # Optional. Network config is used to configure how Pipeline resolves and connects to a destination.
+            "networkAttachment": "A String", # Required. Name of the NetworkAttachment that allows access to the consumer VPC. Format: `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}`
+          },
+          "outputPayloadFormat": { # Represents the format of message data. # Optional. The message format before it is delivered to the destination. If not set, the message will be delivered in the format it was originally delivered to the Pipeline. This field can only be set if Pipeline.input_payload_format is also set.
+            "avro": { # The format of an AVRO message payload. # Optional. Avro format.
+              "schemaDefinition": "A String", # Optional. The entire schema definition is stored in this field.
+            },
+            "json": { # The format of a JSON message payload. # Optional. JSON format.
+            },
+            "protobuf": { # The format of a Protobuf message payload. # Optional. Protobuf format.
+              "schemaDefinition": "A String", # Optional. The entire schema definition is stored in this field.
+            },
+          },
+          "topic": "A String", # Optional. The resource name of the Pub/Sub topic to which events should be published. Format: `projects/{project}/locations/{location}/topics/{topic}`
+          "workflow": "A String", # Optional. The resource name of the Workflow whose Executions are triggered by the events. The Workflow resource should be deployed in the same project as the Pipeline. Format: `projects/{project}/locations/{location}/workflows/{workflow}`
+        },
+      ],
+      "displayName": "A String", # Optional. Display name of resource.
+      "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on create requests to ensure that the client has an up-to-date value before proceeding.
+      "inputPayloadFormat": { # Represents the format of message data. # Optional. The payload format expected for the messages received by the Pipeline. If input_payload_format is set then any messages not matching this format will be treated as persistent errors. If input_payload_format is not set, then the message data will be treated as an opaque binary and no output format can be set on the Pipeline through the Pipeline.Destination.output_payload_format field. Any Mediations on the Pipeline that involve access to the data field will fail as persistent errors.
+        "avro": { # The format of an AVRO message payload. # Optional. Avro format.
+          "schemaDefinition": "A String", # Optional. The entire schema definition is stored in this field.
+        },
+        "json": { # The format of a JSON message payload. # Optional. JSON format.
+        },
+        "protobuf": { # The format of a Protobuf message payload. # Optional. Protobuf format.
+          "schemaDefinition": "A String", # Optional. The entire schema definition is stored in this field.
+        },
+      },
+      "labels": { # Optional. User labels attached to the Pipeline that can be used to group resources. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
+        "a_key": "A String",
+      },
+      "loggingConfig": { # The configuration for Platform Telemetry logging for Eventarc Avdvanced resources. # Optional. Config to control Platform Logging for Pipelines.
+        "logSeverity": "A String", # Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
+      },
+      "mediations": [ # Optional. List of mediation operations to be performed on the message. Currently, only one Transformation operation is allowed in each Pipeline.
+        { # Mediation defines different ways to modify the Pipeline.
+          "transformation": { # Transformation defines the way to transform an incoming message. # Optional. How the Pipeline is to transform messages
+            "transformationTemplate": "A String", # Optional. The template to apply to transform messages.
+          },
+        },
+      ],
+      "name": "A String", # Identifier. The resource name of the Pipeline. Must be unique within the location of the project and must be in `projects/{project}/locations/{location}/pipelines/{pipeline}` format.
+      "retryPolicy": { # The retry policy configuration for the Pipeline. The pipeline exponentially backs off in case the destination is non responsive or returns a retryable error code. The default semantics are as follows: The backoff starts with a 5 second delay and doubles the delay after each failed attempt (10 seconds, 20 seconds, 40 seconds, etc.). The delay is capped at 60 seconds by default. Please note that if you set the min_retry_delay and max_retry_delay fields to the same value this will make the duration between retries constant. # Optional. The retry policy to use in the pipeline.
+        "maxAttempts": 42, # Optional. The maximum number of delivery attempts for any message. The value must be between 1 and 100. The default value for this field is 5.
+        "maxRetryDelay": "A String", # Optional. The maximum amount of seconds to wait between retry attempts. The value must be between 0 and 600. The default value for this field is 60.
+        "minRetryDelay": "A String", # Optional. The minimum amount of seconds to wait between retry attempts. The value must be between 0 and 600. The default value for this field is 5.
+      },
+      "uid": "A String", # Output only. Server-assigned unique identifier for the Pipeline. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+      "updateTime": "A String", # Output only. The last-modified time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
+    },
+  ],
+  "unreachable": [ # Unreachable resources, if any.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, allowMissing=None, body=None, updateMask=None, validateOnly=None, x__xgafv=None) +
Update a single pipeline.
+
+Args:
+  name: string, Identifier. The resource name of the Pipeline. Must be unique within the location of the project and must be in `projects/{project}/locations/{location}/pipelines/{pipeline}` format. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A representation of the Pipeline resource.
+  "annotations": { # Optional. User-defined annotations. See https://google.aip.dev/128#annotations.
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. The creation time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
+  "cryptoKeyName": "A String", # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt the event data. If not set, an internal Google-owned key will be used to encrypt messages. It must match the pattern "projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}".
+  "destinations": [ # Required. List of destinations to which messages will be forwarded. Currently, exactly one destination is supported per Pipeline.
+    { # Represents a target of an invocation over HTTP.
+      "authenticationConfig": { # Represents a config used to authenticate message requests. # Optional. An authentication config used to authenticate message requests, such that destinations can verify the source. For example, this can be used with private GCP destinations that require GCP credentials to access like Cloud Run. This field is optional and should be set only by users interested in authenticated push
+        "googleOidc": { # Represents a config used to authenticate with a Google OIDC token using a GCP service account. Use this authentication method to invoke your Cloud Run and Cloud Functions destinations or HTTP endpoints that support Google OIDC. # Optional. This authenticate method will apply Google OIDC tokens signed by a GCP service account to the requests.
+          "audience": "A String", # Optional. Audience to be used to generate the OIDC Token. The audience claim identifies the recipient that the JWT is intended for. If unspecified, the destination URI will be used.
+          "serviceAccount": "A String", # Required. Service account email used to generate the OIDC Token. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow the Pipeline to create OpenID tokens for authenticated requests.
+        },
+        "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # Optional. If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
+          "scope": "A String", # Optional. OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
+          "serviceAccount": "A String", # Required. Service account email used to generate the [OAuth token](https://developers.google.com/identity/protocols/OAuth2). The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow Pipeline to create OAuth2 tokens for authenticated requests.
+        },
+      },
+      "httpEndpoint": { # Represents a HTTP endpoint destination. # Optional. An HTTP endpoint destination described by an URI. If a DNS FQDN is provided as the endpoint, Pipeline will create a peering zone to the consumer VPC and forward DNS requests to the VPC specified by network config to resolve the service endpoint. See: https://cloud.google.com/dns/docs/zones/zones-overview#peering_zones
+        "messageBindingTemplate": "A String", # Optional. The CEL expression used to construct a new HTTP request to be sent to the final destination. The result of the CEL expression must be a map of key/value pairs such that: - If a map named `headers` exists on the result of the expression, then its key/value pairs are directly mapped to the HTTP request headers. The headers values are constructed from the corresponding value type’s canonical representation. If the `headers` field doesn’t exist then the resulting HTTP request will be without headers. - If a field named `body` exists on the result of the expression then its value is directly mapped to the body of the request. If the value of the `body` field is of type bytes or string then it is used for the HTTP request body as-is, with no conversion. If the body field is of any other type then it is converted to a JSON string. If the body field doesn’t exist then the resulting HTTP request will be without a body. - Any other fields in the resulting expression will be ignored. The CEL expression may access the incoming CloudEvent message in its definition, as follows: - The `data` field of the incoming CloudEvent message can be accessed using the `message.data` value. - Each attribute of the incoming CloudEvent message can be accessed using the `message.` value, where is replaced with the name of the attribute. Headers added to the request by previous filters in the chain can be accessed in the CEL expression using the `headers` variable. The `headers` variable defines a map of key/value pairs corresponding to the HTTP headers added by previous mediation steps and not the headers present on the original incoming request. For example, the following CEL expression can be used to construct a Headers-only HTTP request by adding an additional header to the headers added by previous mediations in the Pipeline: ``` {"headers": headers.merge({"new-header-key": "new-header-value"})} ``` Additionally, the following CEL extension functions are provided for use in this CEL expression: - toBase64Url: map.toBase64Url() -> string - Converts a CelValue to a base64url encoded string - toJsonString: map.toJsonString() -> string - Converts a CelValue to a JSON string - merge: map1.merge(map2) -> map3 - Merges the passed CEL map with the existing CEL map the function is applied to. - If the same key exists in both maps, if the key's value is type map both maps are merged else the value from the passed map is used. - toMap: list(map).toMap() -> map - Converts a CEL list of CEL maps to a single CEL map - toDestinationPayloadFormat(): message.data.toDestinationPayloadFormat() -> string or bytes - Converts the message data to the destination payload format specified in Pipeline.Destination.output_payload_format - This function is meant to be applied to the message.data field. - If the destination payload format is not set, the function will return the message data unchanged. - toCloudEventJsonWithPayloadFormat: message.toCloudEventJsonWithPayloadFormat() -> map - Converts a message to the corresponding structure of JSON format for CloudEvents - This function applies toDestinationPayloadFormat() to the message data. It also sets the corresponding datacontenttype of the CloudEvent, as indicated by Pipeline.Destination.output_payload_format. If no output_payload_format is set it will use the existing datacontenttype on the CloudEvent if present, else leave datacontenttype absent. - This function expects that the content of the message will adhere to the standard CloudEvent format. If it doesn’t then this function will fail. - The result is a CEL map that corresponds to the JSON representation of the CloudEvent. To convert that data to a JSON string it can be chained with the toJsonString function. If a binding is not specified here, by default the message is treated as a CloudEvent and is mapped to the HTTP request according to the CloudEvent HTTP Protocol Binding Binary Content Mode. The Pipeline converts the data field of the message to the format provided in Pipeline.Destination.output_payload_format and maps it to the body field of the result. It also sets the corresponding Content-Type header to the output_payload_format type. If the Pipeline.Destination.output_payload_format is not set, then the Pipeline will treat the data field of the message as opaque binary data and attach it to the request body as bytes. In this case the Content-type header will be set to the value of the datacontenttype attribute set on the incoming CloudEvent message if present and the `application/octet-stream` MIME type otherwise. The Pipeline expects that the content of the message will adhere to the standard CloudEvent format. If it doesn’t then the outgoing message request may fail with a persistent error.
+        "uri": "A String", # Required. The URI of the HTTP enpdoint. The value must be a RFC2396 URI string. Examples: `http://10.10.10.8:80/route`, `http://svc.us-central1.p.local:8080/`. Only HTTP and HTTPS protocols are supported. The host can be either a static IP addressable from the VPC specified by the network config, or an internal DNS hostname of the service resolvable via Cloud DNS.
+      },
+      "messageBus": "A String", # Optional. The resource name of the Message Bus to which events should be published. The Message Bus resource should exist in the same project as the Pipeline. Format: `projects/{project}/locations/{location}/messageBuses/{message_bus}`
+      "networkConfig": { # Represents a network config to be used for destination resolution and connectivity. # Optional. Network config is used to configure how Pipeline resolves and connects to a destination.
+        "networkAttachment": "A String", # Required. Name of the NetworkAttachment that allows access to the consumer VPC. Format: `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}`
+      },
+      "outputPayloadFormat": { # Represents the format of message data. # Optional. The message format before it is delivered to the destination. If not set, the message will be delivered in the format it was originally delivered to the Pipeline. This field can only be set if Pipeline.input_payload_format is also set.
+        "avro": { # The format of an AVRO message payload. # Optional. Avro format.
+          "schemaDefinition": "A String", # Optional. The entire schema definition is stored in this field.
+        },
+        "json": { # The format of a JSON message payload. # Optional. JSON format.
+        },
+        "protobuf": { # The format of a Protobuf message payload. # Optional. Protobuf format.
+          "schemaDefinition": "A String", # Optional. The entire schema definition is stored in this field.
+        },
+      },
+      "topic": "A String", # Optional. The resource name of the Pub/Sub topic to which events should be published. Format: `projects/{project}/locations/{location}/topics/{topic}`
+      "workflow": "A String", # Optional. The resource name of the Workflow whose Executions are triggered by the events. The Workflow resource should be deployed in the same project as the Pipeline. Format: `projects/{project}/locations/{location}/workflows/{workflow}`
+    },
+  ],
+  "displayName": "A String", # Optional. Display name of resource.
+  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on create requests to ensure that the client has an up-to-date value before proceeding.
+  "inputPayloadFormat": { # Represents the format of message data. # Optional. The payload format expected for the messages received by the Pipeline. If input_payload_format is set then any messages not matching this format will be treated as persistent errors. If input_payload_format is not set, then the message data will be treated as an opaque binary and no output format can be set on the Pipeline through the Pipeline.Destination.output_payload_format field. Any Mediations on the Pipeline that involve access to the data field will fail as persistent errors.
+    "avro": { # The format of an AVRO message payload. # Optional. Avro format.
+      "schemaDefinition": "A String", # Optional. The entire schema definition is stored in this field.
+    },
+    "json": { # The format of a JSON message payload. # Optional. JSON format.
+    },
+    "protobuf": { # The format of a Protobuf message payload. # Optional. Protobuf format.
+      "schemaDefinition": "A String", # Optional. The entire schema definition is stored in this field.
+    },
+  },
+  "labels": { # Optional. User labels attached to the Pipeline that can be used to group resources. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
+    "a_key": "A String",
+  },
+  "loggingConfig": { # The configuration for Platform Telemetry logging for Eventarc Avdvanced resources. # Optional. Config to control Platform Logging for Pipelines.
+    "logSeverity": "A String", # Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
+  },
+  "mediations": [ # Optional. List of mediation operations to be performed on the message. Currently, only one Transformation operation is allowed in each Pipeline.
+    { # Mediation defines different ways to modify the Pipeline.
+      "transformation": { # Transformation defines the way to transform an incoming message. # Optional. How the Pipeline is to transform messages
+        "transformationTemplate": "A String", # Optional. The template to apply to transform messages.
+      },
+    },
+  ],
+  "name": "A String", # Identifier. The resource name of the Pipeline. Must be unique within the location of the project and must be in `projects/{project}/locations/{location}/pipelines/{pipeline}` format.
+  "retryPolicy": { # The retry policy configuration for the Pipeline. The pipeline exponentially backs off in case the destination is non responsive or returns a retryable error code. The default semantics are as follows: The backoff starts with a 5 second delay and doubles the delay after each failed attempt (10 seconds, 20 seconds, 40 seconds, etc.). The delay is capped at 60 seconds by default. Please note that if you set the min_retry_delay and max_retry_delay fields to the same value this will make the duration between retries constant. # Optional. The retry policy to use in the pipeline.
+    "maxAttempts": 42, # Optional. The maximum number of delivery attempts for any message. The value must be between 1 and 100. The default value for this field is 5.
+    "maxRetryDelay": "A String", # Optional. The maximum amount of seconds to wait between retry attempts. The value must be between 0 and 600. The default value for this field is 60.
+    "minRetryDelay": "A String", # Optional. The minimum amount of seconds to wait between retry attempts. The value must be between 0 and 600. The default value for this field is 5.
+  },
+  "uid": "A String", # Output only. Server-assigned unique identifier for the Pipeline. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+  "updateTime": "A String", # Output only. The last-modified time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
+}
+
+  allowMissing: boolean, Optional. If set to true, and the Pipeline is not found, a new Pipeline will be created. In this situation, `update_mask` is ignored.
+  updateMask: string, Optional. The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*".
+  validateOnly: boolean, Optional. If set, validate the request and preview the review, but do not post it.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
diff --git a/docs/dyn/file_v1.projects.locations.instances.html b/docs/dyn/file_v1.projects.locations.instances.html
index c27a00a6ea..735e327888 100644
--- a/docs/dyn/file_v1.projects.locations.instances.html
+++ b/docs/dyn/file_v1.projects.locations.instances.html
@@ -169,10 +169,12 @@ 

Method Details

], "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Used to configure performance. "fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIops": "A String", # Required. Maximum raw read IOPS. + "maxIops": "A String", # Required. Maximum IOPS. + "maxReadIops": "A String", # Optional. Deprecated: `max_iops` should be used instead of this parameter. Maximum raw read IOPS. }, "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIopsPerTb": "A String", # Required. Maximum read IOPS per TiB. + "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. + "maxReadIopsPerTb": "A String", # Optional. Deprecated: `max_iops_per_tb` should be used instead of this parameter. Maximum read IOPS per TiB. }, }, "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. @@ -333,10 +335,12 @@

Method Details

], "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Used to configure performance. "fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIops": "A String", # Required. Maximum raw read IOPS. + "maxIops": "A String", # Required. Maximum IOPS. + "maxReadIops": "A String", # Optional. Deprecated: `max_iops` should be used instead of this parameter. Maximum raw read IOPS. }, "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIopsPerTb": "A String", # Required. Maximum read IOPS per TiB. + "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. + "maxReadIopsPerTb": "A String", # Optional. Deprecated: `max_iops_per_tb` should be used instead of this parameter. Maximum read IOPS per TiB. }, }, "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. @@ -438,10 +442,12 @@

Method Details

], "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Used to configure performance. "fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIops": "A String", # Required. Maximum raw read IOPS. + "maxIops": "A String", # Required. Maximum IOPS. + "maxReadIops": "A String", # Optional. Deprecated: `max_iops` should be used instead of this parameter. Maximum raw read IOPS. }, "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIopsPerTb": "A String", # Required. Maximum read IOPS per TiB. + "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. + "maxReadIopsPerTb": "A String", # Optional. Deprecated: `max_iops_per_tb` should be used instead of this parameter. Maximum read IOPS per TiB. }, }, "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. @@ -552,10 +558,12 @@

Method Details

], "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Used to configure performance. "fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIops": "A String", # Required. Maximum raw read IOPS. + "maxIops": "A String", # Required. Maximum IOPS. + "maxReadIops": "A String", # Optional. Deprecated: `max_iops` should be used instead of this parameter. Maximum raw read IOPS. }, "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIopsPerTb": "A String", # Required. Maximum read IOPS per TiB. + "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. + "maxReadIopsPerTb": "A String", # Optional. Deprecated: `max_iops_per_tb` should be used instead of this parameter. Maximum read IOPS per TiB. }, }, "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. diff --git a/docs/dyn/file_v1beta1.projects.locations.instances.html b/docs/dyn/file_v1beta1.projects.locations.instances.html index 64429e087f..30b4d3df47 100644 --- a/docs/dyn/file_v1beta1.projects.locations.instances.html +++ b/docs/dyn/file_v1beta1.projects.locations.instances.html @@ -188,10 +188,12 @@

Method Details

], "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Used to configure performance. "fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIops": "A String", # Required. Maximum raw read IOPS. + "maxIops": "A String", # Required. Maximum raw IOPS. + "maxReadIops": "A String", # Optional. Deprecated: `max_iops` should be used instead of this parameter. Maximum raw read IOPS. }, "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIopsPerTb": "A String", # Required. Maximum read IOPS per TiB. + "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. + "maxReadIopsPerTb": "A String", # Optional. Deprecated: `max_iops_per_tb` should be used instead of this parameter. Maximum read IOPS per TiB. }, }, "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. @@ -366,10 +368,12 @@

Method Details

], "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Used to configure performance. "fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIops": "A String", # Required. Maximum raw read IOPS. + "maxIops": "A String", # Required. Maximum raw IOPS. + "maxReadIops": "A String", # Optional. Deprecated: `max_iops` should be used instead of this parameter. Maximum raw read IOPS. }, "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIopsPerTb": "A String", # Required. Maximum read IOPS per TiB. + "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. + "maxReadIopsPerTb": "A String", # Optional. Deprecated: `max_iops_per_tb` should be used instead of this parameter. Maximum read IOPS per TiB. }, }, "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. @@ -485,10 +489,12 @@

Method Details

], "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Used to configure performance. "fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIops": "A String", # Required. Maximum raw read IOPS. + "maxIops": "A String", # Required. Maximum raw IOPS. + "maxReadIops": "A String", # Optional. Deprecated: `max_iops` should be used instead of this parameter. Maximum raw read IOPS. }, "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIopsPerTb": "A String", # Required. Maximum read IOPS per TiB. + "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. + "maxReadIopsPerTb": "A String", # Optional. Deprecated: `max_iops_per_tb` should be used instead of this parameter. Maximum read IOPS per TiB. }, }, "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. @@ -613,10 +619,12 @@

Method Details

], "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Used to configure performance. "fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIops": "A String", # Required. Maximum raw read IOPS. + "maxIops": "A String", # Required. Maximum raw IOPS. + "maxReadIops": "A String", # Optional. Deprecated: `max_iops` should be used instead of this parameter. Maximum raw read IOPS. }, "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIopsPerTb": "A String", # Required. Maximum read IOPS per TiB. + "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. + "maxReadIopsPerTb": "A String", # Optional. Deprecated: `max_iops_per_tb` should be used instead of this parameter. Maximum read IOPS per TiB. }, }, "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. diff --git a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html index afd0b366f0..f53c2c540f 100644 --- a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html +++ b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Get results for automated test run on release.

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

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

List results for automated tests run on release.

list_next()

@@ -156,6 +156,7 @@

Method Details

"description": "A String", # Output only. A short description of the high level action taken by the AI agent. "deviceInteractions": [ # Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc. { # An interaction with the device, such as a tap, text entry, wait, etc. + "keyCode": "A String", # Output only. Key code for a key event action. "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken. "height": 42, # Output only. The height of the screenshot, in pixels. "uri": "A String", # Output only. The URI of the screenshot. @@ -281,6 +282,7 @@

Method Details

"description": "A String", # Output only. A short description of the high level action taken by the AI agent. "deviceInteractions": [ # Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc. { # An interaction with the device, such as a tap, text entry, wait, etc. + "keyCode": "A String", # Output only. Key code for a key event action. "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken. "height": 42, # Output only. The height of the screenshot, in pixels. "uri": "A String", # Output only. The URI of the screenshot. @@ -412,6 +414,7 @@

Method Details

"description": "A String", # Output only. A short description of the high level action taken by the AI agent. "deviceInteractions": [ # Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc. { # An interaction with the device, such as a tap, text entry, wait, etc. + "keyCode": "A String", # Output only. Key code for a key event action. "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken. "height": 42, # Output only. The height of the screenshot, in pixels. "uri": "A String", # Output only. The URI of the screenshot. @@ -499,13 +502,18 @@

Method Details

- list(parent, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)
List results for automated tests run on release.
 
 Args:
   parent: string, Required. The name of the release resource, which is the parent of the tests Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}` (required)
   pageSize: integer, Optional. The maximum number of tests to return. The service may return fewer than this value.
   pageToken: string, Optional. A page token, received from a previous `ListReleaseTests` call. Provide this to retrieve the subsequent page.
+  view: string, Optional. The requested view on the returned ReleaseTests. Defaults to the basic view.
+    Allowed values
+      RELEASE_TEST_VIEW_UNSPECIFIED - The default / unset value. The default view depends on the RPC.
+      RELEASE_TEST_VIEW_BASIC - Include basic metadata about the release test and its status, but not the full result details. This is the default value for ListReleaseTests.
+      RELEASE_TEST_VIEW_FULL - Include everything.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -548,6 +556,7 @@ 

Method Details

"description": "A String", # Output only. A short description of the high level action taken by the AI agent. "deviceInteractions": [ # Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc. { # An interaction with the device, such as a tap, text entry, wait, etc. + "keyCode": "A String", # Output only. Key code for a key event action. "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken. "height": 42, # Output only. The height of the screenshot, in pixels. "uri": "A String", # Output only. The URI of the screenshot. diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index ea396de88b..9bd9b97957 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -252,7 +252,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. This field is only used by the Gemini Developer API services. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 @@ -545,7 +545,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. This field is only used by the Gemini Developer API services. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 @@ -995,7 +995,7 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. This field is only used by the Gemini Developer API services. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 diff --git a/docs/dyn/firestore_v1.projects.databases.documents.html b/docs/dyn/firestore_v1.projects.databases.documents.html index 613c16b7ef..d449287ff9 100644 --- a/docs/dyn/firestore_v1.projects.databases.documents.html +++ b/docs/dyn/firestore_v1.projects.databases.documents.html @@ -1197,7 +1197,7 @@

Method Details

"once": True or False, # If the target should be removed once it is current and consistent. "query": { # A target specified by a query. # A target specified by a query. "parent": "A String", # The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` - "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit # A structured query. + "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest # A structured query. "endAt": { # A position in a query result set. # A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause. "before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. @@ -1230,7 +1230,7 @@

Method Details

"findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "distanceResultField": "A String", # Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to document field name limitations. - "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance >= distance_threshold + "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -1475,7 +1475,7 @@

Method Details

"pageToken": "A String", # The `next_page_token` value returned from a previous call to PartitionQuery that may be used to get an additional set of results. There are no ordering guarantees between sets of results. Thus, using multiple sets of results will require merging the different result sets. For example, two subsequent calls using a page_token may return: * cursor B, cursor M, cursor Q * cursor A, cursor U, cursor W To obtain a complete result set ordered with respect to the results of the query supplied to PartitionQuery, the results sets should be merged: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W "partitionCount": "A String", # The desired maximum number of partition points. The partitions may be returned across multiple pages of results. The number must be positive. The actual number of partitions returned may be fewer. For example, this may be set to one fewer than the number of parallel queries to be run, or in running a data pipeline job, one fewer than the number of workers or compute instances available. "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. - "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit # A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported. + "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest # A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported. "endAt": { # A position in a query result set. # A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause. "before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. @@ -1508,7 +1508,7 @@

Method Details

"findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "distanceResultField": "A String", # Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to document field name limitations. - "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance >= distance_threshold + "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -1847,7 +1847,7 @@

Method Details

}, }, ], - "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit # Nested structured query. + "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest # Nested structured query. "endAt": { # A position in a query result set. # A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause. "before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. @@ -1880,7 +1880,7 @@

Method Details

"findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "distanceResultField": "A String", # Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to document field name limitations. - "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance >= distance_threshold + "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -2092,7 +2092,7 @@

Method Details

}, }, "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. - "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit # A structured query. + "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest # A structured query. "endAt": { # A position in a query result set. # A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause. "before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. @@ -2125,7 +2125,7 @@

Method Details

"findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "distanceResultField": "A String", # Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to document field name limitations. - "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance >= distance_threshold + "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. diff --git a/docs/dyn/firestore_v1beta1.projects.databases.documents.html b/docs/dyn/firestore_v1beta1.projects.databases.documents.html index 8432c384c7..91c675b787 100644 --- a/docs/dyn/firestore_v1beta1.projects.databases.documents.html +++ b/docs/dyn/firestore_v1beta1.projects.databases.documents.html @@ -1197,7 +1197,7 @@

Method Details

"once": True or False, # If the target should be removed once it is current and consistent. "query": { # A target specified by a query. # A target specified by a query. "parent": "A String", # The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` - "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit # A structured query. + "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest # A structured query. "endAt": { # A position in a query result set. # A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause. "before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. @@ -1230,7 +1230,7 @@

Method Details

"findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "distanceResultField": "A String", # Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to document field name limitations. - "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance >= distance_threshold + "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -1475,7 +1475,7 @@

Method Details

"pageToken": "A String", # The `next_page_token` value returned from a previous call to PartitionQuery that may be used to get an additional set of results. There are no ordering guarantees between sets of results. Thus, using multiple sets of results will require merging the different result sets. For example, two subsequent calls using a page_token may return: * cursor B, cursor M, cursor Q * cursor A, cursor U, cursor W To obtain a complete result set ordered with respect to the results of the query supplied to PartitionQuery, the results sets should be merged: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W "partitionCount": "A String", # The desired maximum number of partition points. The partitions may be returned across multiple pages of results. The number must be positive. The actual number of partitions returned may be fewer. For example, this may be set to one fewer than the number of parallel queries to be run, or in running a data pipeline job, one fewer than the number of workers or compute instances available. "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. - "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit # A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported. + "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest # A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported. "endAt": { # A position in a query result set. # A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause. "before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. @@ -1508,7 +1508,7 @@

Method Details

"findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "distanceResultField": "A String", # Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to document field name limitations. - "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance >= distance_threshold + "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -1847,7 +1847,7 @@

Method Details

}, }, ], - "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit # Nested structured query. + "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest # Nested structured query. "endAt": { # A position in a query result set. # A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause. "before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. @@ -1880,7 +1880,7 @@

Method Details

"findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "distanceResultField": "A String", # Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to document field name limitations. - "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance >= distance_threshold + "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -2092,7 +2092,7 @@

Method Details

}, }, "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. - "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit # A structured query. + "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest # A structured query. "endAt": { # A position in a query result set. # A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause. "before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. @@ -2125,7 +2125,7 @@

Method Details

"findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "distanceResultField": "A String", # Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to document field name limitations. - "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance >= distance_threshold + "distanceThreshold": 3.14, # Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. diff --git a/docs/dyn/gkehub_v1.projects.locations.features.html b/docs/dyn/gkehub_v1.projects.locations.features.html index 55f726c64c..fe918ac56e 100644 --- a/docs/dyn/gkehub_v1.projects.locations.features.html +++ b/docs/dyn/gkehub_v1.projects.locations.features.html @@ -138,7 +138,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -337,7 +337,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -552,6 +552,8 @@

Method Details

"configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state. "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync # Current sync status + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook "gitSync": "A String", # Deployment state of the git-sync pod @@ -634,7 +636,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -1091,7 +1093,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -1290,7 +1292,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -1505,6 +1507,8 @@

Method Details

"configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state. "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync # Current sync status + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook "gitSync": "A String", # Deployment state of the git-sync pod @@ -1587,7 +1591,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -2032,7 +2036,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -2231,7 +2235,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -2446,6 +2450,8 @@

Method Details

"configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state. "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync # Current sync status + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook "gitSync": "A String", # Deployment state of the git-sync pod @@ -2528,7 +2534,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -2928,7 +2934,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -3127,7 +3133,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -3342,6 +3348,8 @@

Method Details

"configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state. "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync # Current sync status + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook "gitSync": "A String", # Deployment state of the git-sync pod @@ -3424,7 +3432,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. diff --git a/docs/dyn/gkehub_v1.projects.locations.memberships.html b/docs/dyn/gkehub_v1.projects.locations.memberships.html index bbddbbe480..86f33a40d6 100644 --- a/docs/dyn/gkehub_v1.projects.locations.memberships.html +++ b/docs/dyn/gkehub_v1.projects.locations.memberships.html @@ -139,6 +139,7 @@

Method Details

"oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field. "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API. }, + "clusterTier": "A String", # Output only. The tier of the cluster. "createTime": "A String", # Output only. When the Membership was created. "deleteTime": "A String", # Output only. When the Membership was deleted. "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes. @@ -335,6 +336,7 @@

Method Details

"oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field. "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API. }, + "clusterTier": "A String", # Output only. The tier of the cluster. "createTime": "A String", # Output only. When the Membership was created. "deleteTime": "A String", # Output only. When the Membership was deleted. "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes. @@ -486,6 +488,7 @@

Method Details

"oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field. "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API. }, + "clusterTier": "A String", # Output only. The tier of the cluster. "createTime": "A String", # Output only. When the Membership was created. "deleteTime": "A String", # Output only. When the Membership was deleted. "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes. @@ -596,6 +599,7 @@

Method Details

"oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field. "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API. }, + "clusterTier": "A String", # Output only. The tier of the cluster. "createTime": "A String", # Output only. When the Membership was created. "deleteTime": "A String", # Output only. When the Membership was deleted. "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes. diff --git a/docs/dyn/gkehub_v1.projects.locations.scopes.html b/docs/dyn/gkehub_v1.projects.locations.scopes.html index c9bb9426a9..4bd5df6780 100644 --- a/docs/dyn/gkehub_v1.projects.locations.scopes.html +++ b/docs/dyn/gkehub_v1.projects.locations.scopes.html @@ -368,6 +368,7 @@

Method Details

"oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field. "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API. }, + "clusterTier": "A String", # Output only. The tier of the cluster. "createTime": "A String", # Output only. When the Membership was created. "deleteTime": "A String", # Output only. When the Membership was deleted. "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes. diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.features.html b/docs/dyn/gkehub_v1alpha.projects.locations.features.html index 10277bc6db..992f99e21b 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.features.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.features.html @@ -141,7 +141,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -354,7 +354,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -585,6 +585,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync # Current sync status + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook "gitSync": "A String", # Deployment state of the git-sync pod @@ -670,7 +672,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -1257,7 +1259,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -1470,7 +1472,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -1701,6 +1703,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync # Current sync status + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook "gitSync": "A String", # Deployment state of the git-sync pod @@ -1786,7 +1790,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -2361,7 +2365,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -2574,7 +2578,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -2805,6 +2809,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync # Current sync status + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook "gitSync": "A String", # Deployment state of the git-sync pod @@ -2890,7 +2896,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -3420,7 +3426,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -3633,7 +3639,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -3864,6 +3870,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync # Current sync status + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook "gitSync": "A String", # Deployment state of the git-sync pod @@ -3949,7 +3957,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html b/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html index b9869d9521..fcb444ae2e 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html @@ -154,6 +154,7 @@

Method Details

"oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field. "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API. }, + "clusterTier": "A String", # Output only. The tier of the cluster. "createTime": "A String", # Output only. When the Membership was created. "deleteTime": "A String", # Output only. When the Membership was deleted. "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes. @@ -372,6 +373,7 @@

Method Details

"oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field. "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API. }, + "clusterTier": "A String", # Output only. The tier of the cluster. "createTime": "A String", # Output only. When the Membership was created. "deleteTime": "A String", # Output only. When the Membership was deleted. "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes. @@ -523,6 +525,7 @@

Method Details

"oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field. "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API. }, + "clusterTier": "A String", # Output only. The tier of the cluster. "createTime": "A String", # Output only. When the Membership was created. "deleteTime": "A String", # Output only. When the Membership was deleted. "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes. @@ -630,6 +633,7 @@

Method Details

"oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field. "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API. }, + "clusterTier": "A String", # Output only. The tier of the cluster. "createTime": "A String", # Output only. When the Membership was created. "deleteTime": "A String", # Output only. When the Membership was deleted. "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes. @@ -755,6 +759,7 @@

Method Details

"oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field. "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API. }, + "clusterTier": "A String", # Output only. The tier of the cluster. "createTime": "A String", # Output only. When the Membership was created. "deleteTime": "A String", # Output only. When the Membership was deleted. "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes. @@ -992,6 +997,7 @@

Method Details

"oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field. "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API. }, + "clusterTier": "A String", # Output only. The tier of the cluster. "createTime": "A String", # Output only. When the Membership was created. "deleteTime": "A String", # Output only. When the Membership was deleted. "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes. diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.scopes.html b/docs/dyn/gkehub_v1alpha.projects.locations.scopes.html index 306e28f36d..36ebc022c1 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.scopes.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.scopes.html @@ -368,6 +368,7 @@

Method Details

"oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field. "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API. }, + "clusterTier": "A String", # Output only. The tier of the cluster. "createTime": "A String", # Output only. When the Membership was created. "deleteTime": "A String", # Output only. When the Membership was deleted. "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes. diff --git a/docs/dyn/gkehub_v1beta.projects.locations.features.html b/docs/dyn/gkehub_v1beta.projects.locations.features.html index ab54d9fe72..aa45ba63e5 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.features.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.features.html @@ -141,7 +141,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -352,7 +352,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -573,6 +573,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync # Current sync status + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook "gitSync": "A String", # Deployment state of the git-sync pod @@ -658,7 +660,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -1130,7 +1132,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -1341,7 +1343,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -1562,6 +1564,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync # Current sync status + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook "gitSync": "A String", # Deployment state of the git-sync pod @@ -1647,7 +1651,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -2107,7 +2111,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -2318,7 +2322,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -2539,6 +2543,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync # Current sync status + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook "gitSync": "A String", # Deployment state of the git-sync pod @@ -2624,7 +2630,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -3039,7 +3045,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -3250,7 +3256,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -3471,6 +3477,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync # Current sync status + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook "gitSync": "A String", # Deployment state of the git-sync pod @@ -3556,7 +3564,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. diff --git a/docs/dyn/gkehub_v1beta.projects.locations.memberships.html b/docs/dyn/gkehub_v1beta.projects.locations.memberships.html index 273c5c34fa..17c61718fe 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.memberships.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.memberships.html @@ -139,6 +139,7 @@

Method Details

"oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field. "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API. }, + "clusterTier": "A String", # Output only. The tier of the cluster. "createTime": "A String", # Output only. When the Membership was created. "deleteTime": "A String", # Output only. When the Membership was deleted. "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes. @@ -335,6 +336,7 @@

Method Details

"oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field. "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API. }, + "clusterTier": "A String", # Output only. The tier of the cluster. "createTime": "A String", # Output only. When the Membership was created. "deleteTime": "A String", # Output only. When the Membership was deleted. "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes. @@ -486,6 +488,7 @@

Method Details

"oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field. "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API. }, + "clusterTier": "A String", # Output only. The tier of the cluster. "createTime": "A String", # Output only. When the Membership was created. "deleteTime": "A String", # Output only. When the Membership was deleted. "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes. @@ -596,6 +599,7 @@

Method Details

"oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field. "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API. }, + "clusterTier": "A String", # Output only. The tier of the cluster. "createTime": "A String", # Output only. When the Membership was created. "deleteTime": "A String", # Output only. When the Membership was deleted. "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes. diff --git a/docs/dyn/gkehub_v1beta.projects.locations.scopes.html b/docs/dyn/gkehub_v1beta.projects.locations.scopes.html index ca3d52d45e..e92a83ca20 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.scopes.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.scopes.html @@ -368,6 +368,7 @@

Method Details

"oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field. "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API. }, + "clusterTier": "A String", # Output only. The tier of the cluster. "createTime": "A String", # Output only. When the Membership was created. "deleteTime": "A String", # Output only. When the Membership was deleted. "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes. diff --git a/docs/dyn/gkehub_v2.projects.locations.memberships.features.html b/docs/dyn/gkehub_v2.projects.locations.memberships.features.html index a5fb0482b8..342416fbee 100644 --- a/docs/dyn/gkehub_v2.projects.locations.memberships.features.html +++ b/docs/dyn/gkehub_v2.projects.locations.memberships.features.html @@ -148,7 +148,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -370,6 +370,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync. # Current sync status. + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster. # Information about the deployment of ConfigSync, including the version. of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook. "gitSync": "A String", # Deployment state of the git-sync pod. @@ -455,7 +457,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -808,7 +810,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -1030,6 +1032,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync. # Current sync status. + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster. # Information about the deployment of ConfigSync, including the version. of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook. "gitSync": "A String", # Deployment state of the git-sync pod. @@ -1115,7 +1119,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -1408,7 +1412,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -1630,6 +1634,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync. # Current sync status. + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster. # Information about the deployment of ConfigSync, including the version. of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook. "gitSync": "A String", # Deployment state of the git-sync pod. @@ -1715,7 +1721,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -2017,7 +2023,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -2239,6 +2245,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync. # Current sync status. + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster. # Information about the deployment of ConfigSync, including the version. of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook. "gitSync": "A String", # Deployment state of the git-sync pod. @@ -2324,7 +2332,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. diff --git a/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html b/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html index 2cfe43ec0f..e22bb4c510 100644 --- a/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html +++ b/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html @@ -148,7 +148,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -370,6 +370,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync. # Current sync status. + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster. # Information about the deployment of ConfigSync, including the version. of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook. "gitSync": "A String", # Deployment state of the git-sync pod. @@ -455,7 +457,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -808,7 +810,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -1030,6 +1032,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync. # Current sync status. + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster. # Information about the deployment of ConfigSync, including the version. of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook. "gitSync": "A String", # Deployment state of the git-sync pod. @@ -1115,7 +1119,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -1408,7 +1412,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -1630,6 +1634,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync. # Current sync status. + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster. # Information about the deployment of ConfigSync, including the version. of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook. "gitSync": "A String", # Deployment state of the git-sync pod. @@ -1715,7 +1721,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -2017,7 +2023,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -2239,6 +2245,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync. # Current sync status. + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster. # Information about the deployment of ConfigSync, including the version. of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook. "gitSync": "A String", # Deployment state of the git-sync pod. @@ -2324,7 +2332,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. diff --git a/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html b/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html index c6e36ff249..d79621904c 100644 --- a/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html +++ b/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html @@ -148,7 +148,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -370,6 +370,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync. # Current sync status. + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster. # Information about the deployment of ConfigSync, including the version. of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook. "gitSync": "A String", # Deployment state of the git-sync pod. @@ -455,7 +457,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -808,7 +810,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -1030,6 +1032,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync. # Current sync status. + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster. # Information about the deployment of ConfigSync, including the version. of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook. "gitSync": "A String", # Deployment state of the git-sync pod. @@ -1115,7 +1119,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -1408,7 +1412,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -1630,6 +1634,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync. # Current sync status. + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster. # Information about the deployment of ConfigSync, including the version. of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook. "gitSync": "A String", # Deployment state of the git-sync pod. @@ -1715,7 +1721,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -2017,7 +2023,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. @@ -2239,6 +2245,8 @@

Method Details

}, "clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name. "configSyncState": { # State information for ConfigSync. # Current sync status. + "clusterLevelStopSyncingState": "A String", # Whether syncing resources to the cluster is stopped at the cluster level. + "crCount": 42, # Output only. The number of RootSync and RepoSync CRs in the cluster. "deploymentState": { # The state of ConfigSync's deployment on a cluster. # Information about the deployment of ConfigSync, including the version. of the various Pods deployed "admissionWebhook": "A String", # Deployment state of admission-webhook. "gitSync": "A String", # Deployment state of the git-sync pod. @@ -2324,7 +2332,7 @@

Method Details

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. }, - "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. + "metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring. "oci": { # OCI repo configuration for a single cluster. # OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image. diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html index 1592ba9744..8aac0bacca 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html @@ -168,9 +168,9 @@

Method Details

"streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes the output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). - "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. - "tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` - "writeDisposition": "A String", # Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "force": True or False, # Optional. Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "tableUri": "A String", # Optional. BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` + "writeDisposition": "A String", # Optional. Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. }, }, ], @@ -197,9 +197,9 @@

Method Details

"streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes the output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). - "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. - "tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` - "writeDisposition": "A String", # Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "force": True or False, # Optional. Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "tableUri": "A String", # Optional. BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` + "writeDisposition": "A String", # Optional. Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. }, }, ], @@ -373,9 +373,9 @@

Method Details

{ # Exports data from the specified DICOM store. If a given resource, such as a DICOM object with the same SOPInstance UID, already exists in the output, it is overwritten with the version in the source dataset. Exported DICOM data persists when the DICOM store from which it was exported is deleted. "bigqueryDestination": { # The BigQuery table where the server writes the output. # The BigQuery output destination. You can only export to a BigQuery dataset that's in the same project as the DICOM store you're exporting from. The Cloud Healthcare Service Agent requires two IAM roles on the BigQuery location: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. - "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. - "tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` - "writeDisposition": "A String", # Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "force": True or False, # Optional. Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "tableUri": "A String", # Optional. BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` + "writeDisposition": "A String", # Optional. Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. }, "gcsDestination": { # The Cloud Storage location where the server writes the output and the export configuration. # The Cloud Storage output destination. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM roles on the Cloud Storage location. "mimeType": "A String", # MIME types supported by DICOM spec. Each file is written in the following format: `.../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension}` The frame_number component exists only for multi-frame instances. Supported MIME types are consistent with supported formats in DICOMweb: https://cloud.google.com/healthcare/docs/dicom#retrieve_transaction. Specifically, the following are supported: - application/dicom; transfer-syntax=1.2.840.10008.1.2.1 (uncompressed DICOM) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.50 (DICOM with embedded JPEG Baseline) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.90 (DICOM with embedded JPEG 2000 Lossless Only) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.91 (DICOM with embedded JPEG 2000) - application/dicom; transfer-syntax=* (DICOM with no transcoding) - application/octet-stream; transfer-syntax=1.2.840.10008.1.2.1 (raw uncompressed PixelData) - application/octet-stream; transfer-syntax=* (raw PixelData in whatever format it was uploaded in) - image/jpeg; transfer-syntax=1.2.840.10008.1.2.4.50 (Consumer JPEG) - image/png The following extensions are used for output files: - application/dicom -> .dcm - image/jpeg -> .jpg - image/png -> .png - application/octet-stream -> no extension If unspecified, the instances are exported in the original DICOM format they were uploaded in. @@ -438,9 +438,9 @@

Method Details

"streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes the output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). - "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. - "tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` - "writeDisposition": "A String", # Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "force": True or False, # Optional. Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "tableUri": "A String", # Optional. BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` + "writeDisposition": "A String", # Optional. Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. }, }, ], @@ -597,9 +597,9 @@

Method Details

"streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes the output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). - "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. - "tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` - "writeDisposition": "A String", # Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "force": True or False, # Optional. Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "tableUri": "A String", # Optional. BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` + "writeDisposition": "A String", # Optional. Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. }, }, ], @@ -644,9 +644,9 @@

Method Details

"streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes the output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). - "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. - "tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` - "writeDisposition": "A String", # Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "force": True or False, # Optional. Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "tableUri": "A String", # Optional. BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` + "writeDisposition": "A String", # Optional. Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. }, }, ], @@ -673,9 +673,9 @@

Method Details

"streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes the output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). - "force": True or False, # Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. - "tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` - "writeDisposition": "A String", # Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. + "force": True or False, # Optional. Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "tableUri": "A String", # Optional. BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` + "writeDisposition": "A String", # Optional. Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. }, }, ], diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html index 7100ff4d68..44084ff329 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html @@ -140,7 +140,7 @@

Method Details

The object takes the form of: { # Represents a FHIR store. - "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. + "complexDataTypeReferenceParsing": "A String", # Optional. Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. "defaultSearchHandlingStrict": True or False, # Optional. If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. @@ -175,7 +175,7 @@

Method Details

}, "writeDisposition": "A String", # Optional. Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, - "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Resources deleted from the source store will be deleted from the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "config": { # Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime. # The configuration to use when de-identifying resources that are added to this store. "dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. @@ -268,19 +268,19 @@

Method Details

}, "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, - "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + "store": "A String", # Optional. The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, "resourceTypes": [ # Optional. Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. "A String", ], }, ], - "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. + "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Optional. Configuration for how to validate incoming FHIR resources against configured profiles. + "disableFhirpathValidation": True or False, # Optional. Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Optional. Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Optional. Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Optional. Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "enabledImplementationGuides": [ # Optional. A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], }, @@ -297,7 +297,7 @@

Method Details

An object of the form: { # Represents a FHIR store. - "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. + "complexDataTypeReferenceParsing": "A String", # Optional. Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. "defaultSearchHandlingStrict": True or False, # Optional. If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. @@ -332,7 +332,7 @@

Method Details

}, "writeDisposition": "A String", # Optional. Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, - "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Resources deleted from the source store will be deleted from the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "config": { # Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime. # The configuration to use when de-identifying resources that are added to this store. "dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. @@ -425,19 +425,19 @@

Method Details

}, "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, - "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + "store": "A String", # Optional. The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, "resourceTypes": [ # Optional. Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. "A String", ], }, ], - "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. + "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Optional. Configuration for how to validate incoming FHIR resources against configured profiles. + "disableFhirpathValidation": True or False, # Optional. Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Optional. Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Optional. Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Optional. Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "enabledImplementationGuides": [ # Optional. A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], }, @@ -680,7 +680,7 @@

Method Details

An object of the form: { # Represents a FHIR store. - "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. + "complexDataTypeReferenceParsing": "A String", # Optional. Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. "defaultSearchHandlingStrict": True or False, # Optional. If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. @@ -715,7 +715,7 @@

Method Details

}, "writeDisposition": "A String", # Optional. Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, - "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Resources deleted from the source store will be deleted from the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "config": { # Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime. # The configuration to use when de-identifying resources that are added to this store. "dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. @@ -808,19 +808,19 @@

Method Details

}, "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, - "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + "store": "A String", # Optional. The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, "resourceTypes": [ # Optional. Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. "A String", ], }, ], - "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. + "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Optional. Configuration for how to validate incoming FHIR resources against configured profiles. + "disableFhirpathValidation": True or False, # Optional. Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Optional. Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Optional. Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Optional. Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "enabledImplementationGuides": [ # Optional. A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], }, @@ -967,7 +967,7 @@

Method Details

{ # Lists the FHIR stores in the given dataset. "fhirStores": [ # The returned FHIR stores. Won't be more FHIR stores than the value of page_size in the request. { # Represents a FHIR store. - "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. + "complexDataTypeReferenceParsing": "A String", # Optional. Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. "defaultSearchHandlingStrict": True or False, # Optional. If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. @@ -1002,7 +1002,7 @@

Method Details

}, "writeDisposition": "A String", # Optional. Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, - "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Resources deleted from the source store will be deleted from the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "config": { # Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime. # The configuration to use when de-identifying resources that are added to this store. "dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. @@ -1095,19 +1095,19 @@

Method Details

}, "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, - "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + "store": "A String", # Optional. The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, "resourceTypes": [ # Optional. Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. "A String", ], }, ], - "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. + "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Optional. Configuration for how to validate incoming FHIR resources against configured profiles. + "disableFhirpathValidation": True or False, # Optional. Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Optional. Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Optional. Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Optional. Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "enabledImplementationGuides": [ # Optional. A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], }, @@ -1142,7 +1142,7 @@

Method Details

The object takes the form of: { # Represents a FHIR store. - "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. + "complexDataTypeReferenceParsing": "A String", # Optional. Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. "defaultSearchHandlingStrict": True or False, # Optional. If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. @@ -1177,7 +1177,7 @@

Method Details

}, "writeDisposition": "A String", # Optional. Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, - "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Resources deleted from the source store will be deleted from the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "config": { # Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime. # The configuration to use when de-identifying resources that are added to this store. "dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. @@ -1270,19 +1270,19 @@

Method Details

}, "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, - "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + "store": "A String", # Optional. The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, "resourceTypes": [ # Optional. Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. "A String", ], }, ], - "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. + "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Optional. Configuration for how to validate incoming FHIR resources against configured profiles. + "disableFhirpathValidation": True or False, # Optional. Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Optional. Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Optional. Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Optional. Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "enabledImplementationGuides": [ # Optional. A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], }, @@ -1299,7 +1299,7 @@

Method Details

An object of the form: { # Represents a FHIR store. - "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. + "complexDataTypeReferenceParsing": "A String", # Optional. Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. "defaultSearchHandlingStrict": True or False, # Optional. If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. @@ -1334,7 +1334,7 @@

Method Details

}, "writeDisposition": "A String", # Optional. Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, - "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Resources deleted from the source store will be deleted from the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "config": { # Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime. # The configuration to use when de-identifying resources that are added to this store. "dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content. "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. @@ -1427,19 +1427,19 @@

Method Details

}, "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, - "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + "store": "A String", # Optional. The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, "resourceTypes": [ # Optional. Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. "A String", ], }, ], - "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. + "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Optional. Configuration for how to validate incoming FHIR resources against configured profiles. + "disableFhirpathValidation": True or False, # Optional. Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Optional. Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Optional. Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Optional. Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "enabledImplementationGuides": [ # Optional. A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], }, diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.html index 1d4622995d..830fac2a6a 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.html @@ -207,7 +207,7 @@

Method Details

], "unexpectedSegmentHandling": "A String", # Optional. Determines how unexpected segments (segments not matched to the schema) are handled. }, - "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. + "segmentTerminator": "A String", # Optional. Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. "version": "A String", # Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. }, "rejectDuplicateMessage": True or False, # Optional. Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. @@ -293,7 +293,7 @@

Method Details

], "unexpectedSegmentHandling": "A String", # Optional. Determines how unexpected segments (segments not matched to the schema) are handled. }, - "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. + "segmentTerminator": "A String", # Optional. Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. "version": "A String", # Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. }, "rejectDuplicateMessage": True or False, # Optional. Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. @@ -455,7 +455,7 @@

Method Details

], "unexpectedSegmentHandling": "A String", # Optional. Determines how unexpected segments (segments not matched to the schema) are handled. }, - "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. + "segmentTerminator": "A String", # Optional. Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. "version": "A String", # Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. }, "rejectDuplicateMessage": True or False, # Optional. Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. @@ -670,7 +670,7 @@

Method Details

], "unexpectedSegmentHandling": "A String", # Optional. Determines how unexpected segments (segments not matched to the schema) are handled. }, - "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. + "segmentTerminator": "A String", # Optional. Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. "version": "A String", # Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. }, "rejectDuplicateMessage": True or False, # Optional. Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. @@ -774,7 +774,7 @@

Method Details

], "unexpectedSegmentHandling": "A String", # Optional. Determines how unexpected segments (segments not matched to the schema) are handled. }, - "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. + "segmentTerminator": "A String", # Optional. Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. "version": "A String", # Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. }, "rejectDuplicateMessage": True or False, # Optional. Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. @@ -860,7 +860,7 @@

Method Details

], "unexpectedSegmentHandling": "A String", # Optional. Determines how unexpected segments (segments not matched to the schema) are handled. }, - "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. + "segmentTerminator": "A String", # Optional. Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. "version": "A String", # Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. }, "rejectDuplicateMessage": True or False, # Optional. Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html index e706e1a210..23cae37af8 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html @@ -358,7 +358,7 @@

Method Details

}, "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, - "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Resources deleted from the source store will be deleted from the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "config": { # Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime. # The configuration to use when de-identifying resources that are added to this store. "annotation": { # Specifies how to store annotations during de-identification operation. # Configures how annotations, meaning that the location and infoType of sensitive information findings, are created during de-identification. If unspecified, no annotations are created. "annotationStoreName": "A String", # The name of the annotation store, in the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`). * The destination annotation store must be in the same project as the source data. De-identifying data across multiple projects is not supported. * The destination annotation store must exist when using DeidentifyDicomStore or DeidentifyFhirStore. DeidentifyDataset automatically creates the destination annotation store. @@ -645,7 +645,7 @@

Method Details

}, "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, - "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Resources deleted from the source store will be deleted from the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "config": { # Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime. # The configuration to use when de-identifying resources that are added to this store. "annotation": { # Specifies how to store annotations during de-identification operation. # Configures how annotations, meaning that the location and infoType of sensitive information findings, are created during de-identification. If unspecified, no annotations are created. "annotationStoreName": "A String", # The name of the annotation store, in the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`). * The destination annotation store must be in the same project as the source data. De-identifying data across multiple projects is not supported. * The destination annotation store must exist when using DeidentifyDicomStore or DeidentifyFhirStore. DeidentifyDataset automatically creates the destination annotation store. @@ -1367,7 +1367,7 @@

Method Details

}, "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, - "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Resources deleted from the source store will be deleted from the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "config": { # Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime. # The configuration to use when de-identifying resources that are added to this store. "annotation": { # Specifies how to store annotations during de-identification operation. # Configures how annotations, meaning that the location and infoType of sensitive information findings, are created during de-identification. If unspecified, no annotations are created. "annotationStoreName": "A String", # The name of the annotation store, in the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`). * The destination annotation store must be in the same project as the source data. De-identifying data across multiple projects is not supported. * The destination annotation store must exist when using DeidentifyDicomStore or DeidentifyFhirStore. DeidentifyDataset automatically creates the destination annotation store. @@ -1830,7 +1830,7 @@

Method Details

}, "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, - "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Resources deleted from the source store will be deleted from the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "config": { # Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime. # The configuration to use when de-identifying resources that are added to this store. "annotation": { # Specifies how to store annotations during de-identification operation. # Configures how annotations, meaning that the location and infoType of sensitive information findings, are created during de-identification. If unspecified, no annotations are created. "annotationStoreName": "A String", # The name of the annotation store, in the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`). * The destination annotation store must be in the same project as the source data. De-identifying data across multiple projects is not supported. * The destination annotation store must exist when using DeidentifyDicomStore or DeidentifyFhirStore. DeidentifyDataset automatically creates the destination annotation store. @@ -2135,7 +2135,7 @@

Method Details

}, "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, - "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Resources deleted from the source store will be deleted from the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "config": { # Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime. # The configuration to use when de-identifying resources that are added to this store. "annotation": { # Specifies how to store annotations during de-identification operation. # Configures how annotations, meaning that the location and infoType of sensitive information findings, are created during de-identification. If unspecified, no annotations are created. "annotationStoreName": "A String", # The name of the annotation store, in the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`). * The destination annotation store must be in the same project as the source data. De-identifying data across multiple projects is not supported. * The destination annotation store must exist when using DeidentifyDicomStore or DeidentifyFhirStore. DeidentifyDataset automatically creates the destination annotation store. @@ -2422,7 +2422,7 @@

Method Details

}, "writeDisposition": "A String", # Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. }, - "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + "deidentifiedStoreDestination": { # Contains configuration for streaming de-identified FHIR export. # The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Resources deleted from the source store will be deleted from the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "config": { # Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime. # The configuration to use when de-identifying resources that are added to this store. "annotation": { # Specifies how to store annotations during de-identification operation. # Configures how annotations, meaning that the location and infoType of sensitive information findings, are created during de-identification. If unspecified, no annotations are created. "annotationStoreName": "A String", # The name of the annotation store, in the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`). * The destination annotation store must be in the same project as the source data. De-identifying data across multiple projects is not supported. * The destination annotation store must exist when using DeidentifyDicomStore or DeidentifyFhirStore. DeidentifyDataset automatically creates the destination annotation store. diff --git a/docs/dyn/iam_v1.permissions.html b/docs/dyn/iam_v1.permissions.html index 2fb22b2e90..537084f68a 100644 --- a/docs/dyn/iam_v1.permissions.html +++ b/docs/dyn/iam_v1.permissions.html @@ -117,7 +117,7 @@

Method Details

{ # A permission which can be included by a role. "apiDisabled": True or False, # The service API associated with the permission is not enabled. "customRolesSupportLevel": "A String", # The current custom role support level. - "description": "A String", # A brief description of what this Permission is used for. This permission can ONLY be used in predefined roles. + "description": "A String", # A brief description of what this Permission is used for. "name": "A String", # The name of this Permission. "onlyInPredefinedRoles": True or False, "primaryPermission": "A String", # The preferred name for this permission. If present, then this permission is an alias of, and equivalent to, the listed primary_permission. diff --git a/docs/dyn/identitytoolkit_v1.accounts.html b/docs/dyn/identitytoolkit_v1.accounts.html index f8223bf43c..b70e5ba0d9 100644 --- a/docs/dyn/identitytoolkit_v1.accounts.html +++ b/docs/dyn/identitytoolkit_v1.accounts.html @@ -449,11 +449,14 @@

Method Details

"autoRetrievalInfo": { # The information required to auto-retrieve an SMS. # Android only. Used by Google Play Services to identify the app for auto-retrieval. "appSignatureHash": "A String", # The Android app's signature hash for Google Play Service's SMS Retriever API. }, + "captchaResponse": "A String", # Optional. The reCAPTCHA Enterprise token provided by the reCAPTCHA client-side integration. Required when reCAPTCHA enterprise is enabled. + "clientType": "A String", # Optional. The client type, web, android or ios. Required when reCAPTCHA Enterprise is enabled. "iosReceipt": "A String", # Receipt of successful iOS app token validation. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator. This should come from the response of verifyIosClient. If present, the caller should also provide the `ios_secret`, as well as a bundle ID in the `x-ios-bundle-identifier` header, which must match the bundle ID from the verifyIosClient request. "iosSecret": "A String", # Secret delivered to iOS app as a push notification. Should be passed with an `ios_receipt` as well as the `x-ios-bundle-identifier` header. "phoneNumber": "A String", # The phone number to send the verification code to in E.164 format. "playIntegrityToken": "A String", # Android only. Used to assert application identity in place of a recaptcha token (and safety_net_token). At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, , or `play_integrity_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator. A Play Integrity Token can be generated via the [PlayIntegrity API](https://developer.android.com/google/play/integrity) with applying SHA256 to the `phone_number` field as the nonce. "recaptchaToken": "A String", # Recaptcha token for app verification. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator. The recaptcha should be generated by calling getRecaptchaParams and the recaptcha token will be generated on user completion of the recaptcha challenge. + "recaptchaVersion": "A String", # Optional. The reCAPTCHA version of the reCAPTCHA token in the captcha_response. "safetyNetToken": "A String", # Android only. Used to assert application identity in place of a recaptcha token. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator. A SafetyNet Token can be generated via the [SafetyNet Android Attestation API](https://developer.android.com/training/safetynet/attestation.html), with the Base64 encoding of the `phone_number` field as the nonce. "tenantId": "A String", # Tenant ID of the Identity Platform tenant the user is signing in to. } diff --git a/docs/dyn/identitytoolkit_v2.accounts.mfaEnrollment.html b/docs/dyn/identitytoolkit_v2.accounts.mfaEnrollment.html index f381e0d385..cfebe4ba56 100644 --- a/docs/dyn/identitytoolkit_v2.accounts.mfaEnrollment.html +++ b/docs/dyn/identitytoolkit_v2.accounts.mfaEnrollment.html @@ -151,11 +151,14 @@

Method Details

"autoRetrievalInfo": { # The information required to auto-retrieve an SMS. # Android only. Used by Google Play Services to identify the app for auto-retrieval. "appSignatureHash": "A String", # The Android app's signature hash for Google Play Service's SMS Retriever API. }, + "captchaResponse": "A String", # The reCAPTCHA Enterprise token provided by the reCAPTCHA client-side integration. Required when reCAPTCHA enterprise is enabled. + "clientType": "A String", # The client type, web, android or ios. Required when reCAPTCHA Enterprise is enabled. "iosReceipt": "A String", # iOS only. Receipt of successful app token validation with APNS. "iosSecret": "A String", # iOS only. Secret delivered to iOS app via APNS. "phoneNumber": "A String", # Required for enrollment. Phone number to be enrolled as MFA. "playIntegrityToken": "A String", # Android only. Used to assert application identity in place of a recaptcha token (or safety net token). A Play Integrity Token can be generated via the [PlayIntegrity API] (https://developer.android.com/google/play/integrity) with applying SHA256 to the `phone_number` field as the nonce. "recaptchaToken": "A String", # Web only. Recaptcha solution. + "recaptchaVersion": "A String", # The reCAPTCHA version of the reCAPTCHA token in the captcha_response. "safetyNetToken": "A String", # Android only. Used to assert application identity in place of a recaptcha token. A SafetyNet Token can be generated via the [SafetyNet Android Attestation API](https://developer.android.com/training/safetynet/attestation.html), with the Base64 encoding of the `phone_number` field as the nonce. }, "tenantId": "A String", # The ID of the Identity Platform tenant that the user enrolling MFA belongs to. If not set, the user belongs to the default Identity Platform project. diff --git a/docs/dyn/identitytoolkit_v2.accounts.mfaSignIn.html b/docs/dyn/identitytoolkit_v2.accounts.mfaSignIn.html index 8c2f84871d..7c30d866e6 100644 --- a/docs/dyn/identitytoolkit_v2.accounts.mfaSignIn.html +++ b/docs/dyn/identitytoolkit_v2.accounts.mfaSignIn.html @@ -146,11 +146,14 @@

Method Details

"autoRetrievalInfo": { # The information required to auto-retrieve an SMS. # Android only. Used by Google Play Services to identify the app for auto-retrieval. "appSignatureHash": "A String", # The Android app's signature hash for Google Play Service's SMS Retriever API. }, + "captchaResponse": "A String", # The reCAPTCHA Enterprise token provided by the reCAPTCHA client-side integration. Required when reCAPTCHA enterprise is enabled. + "clientType": "A String", # The client type, web, android or ios. Required when reCAPTCHA Enterprise is enabled. "iosReceipt": "A String", # iOS only. Receipt of successful app token validation with APNS. "iosSecret": "A String", # iOS only. Secret delivered to iOS app via APNS. "phoneNumber": "A String", # Required for enrollment. Phone number to be enrolled as MFA. "playIntegrityToken": "A String", # Android only. Used to assert application identity in place of a recaptcha token (or safety net token). A Play Integrity Token can be generated via the [PlayIntegrity API] (https://developer.android.com/google/play/integrity) with applying SHA256 to the `phone_number` field as the nonce. "recaptchaToken": "A String", # Web only. Recaptcha solution. + "recaptchaVersion": "A String", # The reCAPTCHA version of the reCAPTCHA token in the captcha_response. "safetyNetToken": "A String", # Android only. Used to assert application identity in place of a recaptcha token. A SafetyNet Token can be generated via the [SafetyNet Android Attestation API](https://developer.android.com/training/safetynet/attestation.html), with the Base64 encoding of the `phone_number` field as the nonce. }, "tenantId": "A String", # The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform project. diff --git a/docs/dyn/identitytoolkit_v2.projects.html b/docs/dyn/identitytoolkit_v2.projects.html index 58d8e9fdca..00fe6530c1 100644 --- a/docs/dyn/identitytoolkit_v2.projects.html +++ b/docs/dyn/identitytoolkit_v2.projects.html @@ -287,12 +287,19 @@

Method Details

"endScore": 3.14, # The end score (inclusive) of the score range for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the riskiest request (likely a bot), whereas 1.0 indicates the safest request (likely a human). See https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment. }, ], + "phoneEnforcementState": "A String", # The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all related user flows protected by reCAPTCHA. "recaptchaKeys": [ # The reCAPTCHA keys. { # The reCAPTCHA key config. reCAPTCHA Enterprise offers different keys for different client platforms. "key": "A String", # The reCAPTCHA Enterprise key resource name, e.g. "projects/{project}/keys/{key}" "type": "A String", # The client's platform type. }, ], + "tollFraudManagedRules": [ # The managed rules for toll fraud provider, containing the enforcement status. The toll fraud provider contains all SMS related user flows. + { # The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The start_score is maximum_allowed_score. End score is 1.0. + "action": "A String", # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score]. + "startScore": 3.14, # The start score (inclusive) for an action. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms. + }, + ], "useAccountDefender": True or False, # Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`. }, "signIn": { # Configuration related to local sign in methods. # Configuration related to local sign in methods. @@ -502,12 +509,19 @@

Method Details

"endScore": 3.14, # The end score (inclusive) of the score range for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the riskiest request (likely a bot), whereas 1.0 indicates the safest request (likely a human). See https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment. }, ], + "phoneEnforcementState": "A String", # The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all related user flows protected by reCAPTCHA. "recaptchaKeys": [ # The reCAPTCHA keys. { # The reCAPTCHA key config. reCAPTCHA Enterprise offers different keys for different client platforms. "key": "A String", # The reCAPTCHA Enterprise key resource name, e.g. "projects/{project}/keys/{key}" "type": "A String", # The client's platform type. }, ], + "tollFraudManagedRules": [ # The managed rules for toll fraud provider, containing the enforcement status. The toll fraud provider contains all SMS related user flows. + { # The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The start_score is maximum_allowed_score. End score is 1.0. + "action": "A String", # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score]. + "startScore": 3.14, # The start score (inclusive) for an action. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms. + }, + ], "useAccountDefender": True or False, # Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`. }, "signIn": { # Configuration related to local sign in methods. # Configuration related to local sign in methods. @@ -716,12 +730,19 @@

Method Details

"endScore": 3.14, # The end score (inclusive) of the score range for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the riskiest request (likely a bot), whereas 1.0 indicates the safest request (likely a human). See https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment. }, ], + "phoneEnforcementState": "A String", # The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all related user flows protected by reCAPTCHA. "recaptchaKeys": [ # The reCAPTCHA keys. { # The reCAPTCHA key config. reCAPTCHA Enterprise offers different keys for different client platforms. "key": "A String", # The reCAPTCHA Enterprise key resource name, e.g. "projects/{project}/keys/{key}" "type": "A String", # The client's platform type. }, ], + "tollFraudManagedRules": [ # The managed rules for toll fraud provider, containing the enforcement status. The toll fraud provider contains all SMS related user flows. + { # The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The start_score is maximum_allowed_score. End score is 1.0. + "action": "A String", # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score]. + "startScore": 3.14, # The start score (inclusive) for an action. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms. + }, + ], "useAccountDefender": True or False, # Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`. }, "signIn": { # Configuration related to local sign in methods. # Configuration related to local sign in methods. diff --git a/docs/dyn/identitytoolkit_v2.projects.tenants.html b/docs/dyn/identitytoolkit_v2.projects.tenants.html index a05ea12dd1..1fd0bc408d 100644 --- a/docs/dyn/identitytoolkit_v2.projects.tenants.html +++ b/docs/dyn/identitytoolkit_v2.projects.tenants.html @@ -206,12 +206,19 @@

Method Details

"endScore": 3.14, # The end score (inclusive) of the score range for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the riskiest request (likely a bot), whereas 1.0 indicates the safest request (likely a human). See https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment. }, ], + "phoneEnforcementState": "A String", # The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all related user flows protected by reCAPTCHA. "recaptchaKeys": [ # The reCAPTCHA keys. { # The reCAPTCHA key config. reCAPTCHA Enterprise offers different keys for different client platforms. "key": "A String", # The reCAPTCHA Enterprise key resource name, e.g. "projects/{project}/keys/{key}" "type": "A String", # The client's platform type. }, ], + "tollFraudManagedRules": [ # The managed rules for toll fraud provider, containing the enforcement status. The toll fraud provider contains all SMS related user flows. + { # The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The start_score is maximum_allowed_score. End score is 1.0. + "action": "A String", # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score]. + "startScore": 3.14, # The start score (inclusive) for an action. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms. + }, + ], "useAccountDefender": True or False, # Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`. }, "smsRegionConfig": { # Configures the regions where users are allowed to send verification SMS for the project or tenant. This is based on the calling code of the destination phone number. # Configures which regions are enabled for SMS verification code sending. @@ -311,12 +318,19 @@

Method Details

"endScore": 3.14, # The end score (inclusive) of the score range for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the riskiest request (likely a bot), whereas 1.0 indicates the safest request (likely a human). See https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment. }, ], + "phoneEnforcementState": "A String", # The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all related user flows protected by reCAPTCHA. "recaptchaKeys": [ # The reCAPTCHA keys. { # The reCAPTCHA key config. reCAPTCHA Enterprise offers different keys for different client platforms. "key": "A String", # The reCAPTCHA Enterprise key resource name, e.g. "projects/{project}/keys/{key}" "type": "A String", # The client's platform type. }, ], + "tollFraudManagedRules": [ # The managed rules for toll fraud provider, containing the enforcement status. The toll fraud provider contains all SMS related user flows. + { # The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The start_score is maximum_allowed_score. End score is 1.0. + "action": "A String", # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score]. + "startScore": 3.14, # The start score (inclusive) for an action. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms. + }, + ], "useAccountDefender": True or False, # Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`. }, "smsRegionConfig": { # Configures the regions where users are allowed to send verification SMS for the project or tenant. This is based on the calling code of the destination phone number. # Configures which regions are enabled for SMS verification code sending. @@ -441,12 +455,19 @@

Method Details

"endScore": 3.14, # The end score (inclusive) of the score range for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the riskiest request (likely a bot), whereas 1.0 indicates the safest request (likely a human). See https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment. }, ], + "phoneEnforcementState": "A String", # The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all related user flows protected by reCAPTCHA. "recaptchaKeys": [ # The reCAPTCHA keys. { # The reCAPTCHA key config. reCAPTCHA Enterprise offers different keys for different client platforms. "key": "A String", # The reCAPTCHA Enterprise key resource name, e.g. "projects/{project}/keys/{key}" "type": "A String", # The client's platform type. }, ], + "tollFraudManagedRules": [ # The managed rules for toll fraud provider, containing the enforcement status. The toll fraud provider contains all SMS related user flows. + { # The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The start_score is maximum_allowed_score. End score is 1.0. + "action": "A String", # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score]. + "startScore": 3.14, # The start score (inclusive) for an action. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms. + }, + ], "useAccountDefender": True or False, # Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`. }, "smsRegionConfig": { # Configures the regions where users are allowed to send verification SMS for the project or tenant. This is based on the calling code of the destination phone number. # Configures which regions are enabled for SMS verification code sending. @@ -614,12 +635,19 @@

Method Details

"endScore": 3.14, # The end score (inclusive) of the score range for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the riskiest request (likely a bot), whereas 1.0 indicates the safest request (likely a human). See https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment. }, ], + "phoneEnforcementState": "A String", # The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all related user flows protected by reCAPTCHA. "recaptchaKeys": [ # The reCAPTCHA keys. { # The reCAPTCHA key config. reCAPTCHA Enterprise offers different keys for different client platforms. "key": "A String", # The reCAPTCHA Enterprise key resource name, e.g. "projects/{project}/keys/{key}" "type": "A String", # The client's platform type. }, ], + "tollFraudManagedRules": [ # The managed rules for toll fraud provider, containing the enforcement status. The toll fraud provider contains all SMS related user flows. + { # The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The start_score is maximum_allowed_score. End score is 1.0. + "action": "A String", # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score]. + "startScore": 3.14, # The start score (inclusive) for an action. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms. + }, + ], "useAccountDefender": True or False, # Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`. }, "smsRegionConfig": { # Configures the regions where users are allowed to send verification SMS for the project or tenant. This is based on the calling code of the destination phone number. # Configures which regions are enabled for SMS verification code sending. @@ -737,12 +765,19 @@

Method Details

"endScore": 3.14, # The end score (inclusive) of the score range for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the riskiest request (likely a bot), whereas 1.0 indicates the safest request (likely a human). See https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment. }, ], + "phoneEnforcementState": "A String", # The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all related user flows protected by reCAPTCHA. "recaptchaKeys": [ # The reCAPTCHA keys. { # The reCAPTCHA key config. reCAPTCHA Enterprise offers different keys for different client platforms. "key": "A String", # The reCAPTCHA Enterprise key resource name, e.g. "projects/{project}/keys/{key}" "type": "A String", # The client's platform type. }, ], + "tollFraudManagedRules": [ # The managed rules for toll fraud provider, containing the enforcement status. The toll fraud provider contains all SMS related user flows. + { # The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The start_score is maximum_allowed_score. End score is 1.0. + "action": "A String", # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score]. + "startScore": 3.14, # The start score (inclusive) for an action. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms. + }, + ], "useAccountDefender": True or False, # Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`. }, "smsRegionConfig": { # Configures the regions where users are allowed to send verification SMS for the project or tenant. This is based on the calling code of the destination phone number. # Configures which regions are enabled for SMS verification code sending. @@ -843,12 +878,19 @@

Method Details

"endScore": 3.14, # The end score (inclusive) of the score range for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the riskiest request (likely a bot), whereas 1.0 indicates the safest request (likely a human). See https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment. }, ], + "phoneEnforcementState": "A String", # The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all related user flows protected by reCAPTCHA. "recaptchaKeys": [ # The reCAPTCHA keys. { # The reCAPTCHA key config. reCAPTCHA Enterprise offers different keys for different client platforms. "key": "A String", # The reCAPTCHA Enterprise key resource name, e.g. "projects/{project}/keys/{key}" "type": "A String", # The client's platform type. }, ], + "tollFraudManagedRules": [ # The managed rules for toll fraud provider, containing the enforcement status. The toll fraud provider contains all SMS related user flows. + { # The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The start_score is maximum_allowed_score. End score is 1.0. + "action": "A String", # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score]. + "startScore": 3.14, # The start score (inclusive) for an action. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms. + }, + ], "useAccountDefender": True or False, # Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`. }, "smsRegionConfig": { # Configures the regions where users are allowed to send verification SMS for the project or tenant. This is based on the calling code of the destination phone number. # Configures which regions are enabled for SMS verification code sending. diff --git a/docs/dyn/index.md b/docs/dyn/index.md index e9e5ae6587..c561c8c7ae 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -310,6 +310,11 @@ * [v2beta](http://googleapis.github.io/google-api-python-client/docs/dyn/cloudfunctions_v2beta.html) +## cloudidentity +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/cloudidentity_v1.html) +* [v1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/cloudidentity_v1beta1.html) + + ## cloudkms * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/cloudkms_v1.html) @@ -863,6 +868,11 @@ * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/mybusinessverifications_v1.html) +## netapp +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/netapp_v1.html) +* [v1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/netapp_v1beta1.html) + + ## networkconnectivity * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/networkconnectivity_v1.html) * [v1alpha1](http://googleapis.github.io/google-api-python-client/docs/dyn/networkconnectivity_v1alpha1.html) diff --git a/docs/dyn/integrations_v1.projects.locations.integrations.html b/docs/dyn/integrations_v1.projects.locations.integrations.html index 8b70ca82e8..fad43fbd6f 100644 --- a/docs/dyn/integrations_v1.projects.locations.integrations.html +++ b/docs/dyn/integrations_v1.projects.locations.integrations.html @@ -1494,14 +1494,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -1567,14 +1571,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, diff --git a/docs/dyn/integrations_v1.projects.locations.integrations.versions.html b/docs/dyn/integrations_v1.projects.locations.integrations.versions.html index 56f8a9283f..36e9359ad8 100644 --- a/docs/dyn/integrations_v1.projects.locations.integrations.versions.html +++ b/docs/dyn/integrations_v1.projects.locations.integrations.versions.html @@ -971,14 +971,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -1044,14 +1048,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -2015,14 +2023,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -2088,14 +2100,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -3128,14 +3144,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -3201,14 +3221,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -4181,14 +4205,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -4254,14 +4282,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -5237,14 +5269,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -5310,14 +5346,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -6299,14 +6339,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -6372,14 +6416,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -7342,14 +7390,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -7415,14 +7467,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -8451,14 +8507,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -8524,14 +8584,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, 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 b9fcde16c8..370d030c6c 100644 --- a/docs/dyn/integrations_v1.projects.locations.integrations.versions.testCases.html +++ b/docs/dyn/integrations_v1.projects.locations.integrations.versions.testCases.html @@ -374,14 +374,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -662,14 +666,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -1100,14 +1108,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -1402,14 +1414,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -2148,14 +2164,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -2436,14 +2456,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -2736,14 +2760,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -3039,14 +3067,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate diff --git a/docs/dyn/integrations_v1.projects.locations.products.integrations.html b/docs/dyn/integrations_v1.projects.locations.products.integrations.html index e28e933ac2..8356f8f4c6 100644 --- a/docs/dyn/integrations_v1.projects.locations.products.integrations.html +++ b/docs/dyn/integrations_v1.projects.locations.products.integrations.html @@ -1449,14 +1449,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -1522,14 +1526,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, diff --git a/docs/dyn/integrations_v1.projects.locations.products.integrations.versions.html b/docs/dyn/integrations_v1.projects.locations.products.integrations.versions.html index 74130c59e7..d2677329ea 100644 --- a/docs/dyn/integrations_v1.projects.locations.products.integrations.versions.html +++ b/docs/dyn/integrations_v1.projects.locations.products.integrations.versions.html @@ -966,14 +966,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -1039,14 +1043,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -2010,14 +2018,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -2083,14 +2095,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -3112,14 +3128,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -3185,14 +3205,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -4168,14 +4192,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -4241,14 +4269,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -5230,14 +5262,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -5303,14 +5339,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -6273,14 +6313,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -6346,14 +6390,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -7356,14 +7404,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -7429,14 +7481,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -8439,14 +8495,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -8512,14 +8572,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, diff --git a/docs/dyn/integrations_v1.projects.locations.templates.html b/docs/dyn/integrations_v1.projects.locations.templates.html index da902066e9..25a7620e74 100644 --- a/docs/dyn/integrations_v1.projects.locations.templates.html +++ b/docs/dyn/integrations_v1.projects.locations.templates.html @@ -1000,14 +1000,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -1073,14 +1077,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -2037,14 +2045,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -2110,14 +2122,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -3113,14 +3129,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -3186,14 +3206,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -4150,14 +4174,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -4223,14 +4251,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -5275,14 +5307,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -5348,14 +5384,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -6312,14 +6352,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -6385,14 +6429,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -7385,14 +7433,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -7458,14 +7510,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -8419,14 +8475,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -8492,14 +8552,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -9503,14 +9567,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -9576,14 +9644,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -10540,14 +10612,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -10613,14 +10689,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -11634,14 +11714,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -11707,14 +11791,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -12671,14 +12759,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -12744,14 +12836,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -13748,14 +13844,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -13821,14 +13921,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -14785,14 +14889,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -14858,14 +14966,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -15876,14 +15988,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -15949,14 +16065,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -16913,14 +17033,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -16986,14 +17110,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -18075,14 +18203,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -18148,14 +18280,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -19112,14 +19248,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -19185,14 +19325,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -20189,14 +20333,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -20262,14 +20410,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, @@ -21223,14 +21375,18 @@

Method Details

}, "description": "A String", # Optional. User-provided description intended to give additional business context about the task. "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # Optional. The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI. "x": 42, # Required. X axis of the coordinate "y": 42, # Required. Y axis of the coordinate @@ -21296,14 +21452,18 @@

Method Details

"A String", ], "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task - "inputVariables": [ # Optional. List of input variables for the api trigger. - "A String", - ], + "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "label": "A String", # The user created label for a particular trigger. "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed. - "outputVariables": [ # Optional. List of output variables for the api trigger. - "A String", - ], + "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger. + "names": [ # Optional. List of variable names. + "A String", + ], + }, "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed. "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI. "x": 42, diff --git a/docs/dyn/logging_v2.folders.locations.logScopes.html b/docs/dyn/logging_v2.folders.locations.logScopes.html index d85d6659ef..03fb5fd88a 100644 --- a/docs/dyn/logging_v2.folders.locations.logScopes.html +++ b/docs/dyn/logging_v2.folders.locations.logScopes.html @@ -113,8 +113,8 @@

Method Details

{ # Describes a group of resources to read log entries from. "createTime": "A String", # Output only. The creation timestamp of the log scope. "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters. - "name": "A String", # Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope - "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total. + "name": "A String", # Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope + "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total. "A String", ], "updateTime": "A String", # Output only. The last update timestamp of the log scope. @@ -132,8 +132,8 @@

Method Details

{ # Describes a group of resources to read log entries from. "createTime": "A String", # Output only. The creation timestamp of the log scope. "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters. - "name": "A String", # Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope - "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total. + "name": "A String", # Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope + "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total. "A String", ], "updateTime": "A String", # Output only. The last update timestamp of the log scope. @@ -175,8 +175,8 @@

Method Details

{ # Describes a group of resources to read log entries from. "createTime": "A String", # Output only. The creation timestamp of the log scope. "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters. - "name": "A String", # Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope - "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total. + "name": "A String", # Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope + "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total. "A String", ], "updateTime": "A String", # Output only. The last update timestamp of the log scope. @@ -204,8 +204,8 @@

Method Details

{ # Describes a group of resources to read log entries from. "createTime": "A String", # Output only. The creation timestamp of the log scope. "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters. - "name": "A String", # Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope - "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total. + "name": "A String", # Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope + "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total. "A String", ], "updateTime": "A String", # Output only. The last update timestamp of the log scope. @@ -234,15 +234,15 @@

Method Details

Updates a log scope.
 
 Args:
-  name: string, Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope (required)
+  name: string, Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Describes a group of resources to read log entries from.
   "createTime": "A String", # Output only. The creation timestamp of the log scope.
   "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters.
-  "name": "A String", # Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope
-  "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total.
+  "name": "A String", # Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope
+  "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total.
     "A String",
   ],
   "updateTime": "A String", # Output only. The last update timestamp of the log scope.
@@ -260,8 +260,8 @@ 

Method Details

{ # Describes a group of resources to read log entries from. "createTime": "A String", # Output only. The creation timestamp of the log scope. "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters. - "name": "A String", # Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope - "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total. + "name": "A String", # Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope + "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total. "A String", ], "updateTime": "A String", # Output only. The last update timestamp of the log scope. diff --git a/docs/dyn/logging_v2.organizations.locations.logScopes.html b/docs/dyn/logging_v2.organizations.locations.logScopes.html index 220bf9cd45..11d8b125ba 100644 --- a/docs/dyn/logging_v2.organizations.locations.logScopes.html +++ b/docs/dyn/logging_v2.organizations.locations.logScopes.html @@ -113,8 +113,8 @@

Method Details

{ # Describes a group of resources to read log entries from. "createTime": "A String", # Output only. The creation timestamp of the log scope. "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters. - "name": "A String", # Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope - "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total. + "name": "A String", # Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope + "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total. "A String", ], "updateTime": "A String", # Output only. The last update timestamp of the log scope. @@ -132,8 +132,8 @@

Method Details

{ # Describes a group of resources to read log entries from. "createTime": "A String", # Output only. The creation timestamp of the log scope. "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters. - "name": "A String", # Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope - "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total. + "name": "A String", # Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope + "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total. "A String", ], "updateTime": "A String", # Output only. The last update timestamp of the log scope. @@ -175,8 +175,8 @@

Method Details

{ # Describes a group of resources to read log entries from. "createTime": "A String", # Output only. The creation timestamp of the log scope. "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters. - "name": "A String", # Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope - "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total. + "name": "A String", # Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope + "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total. "A String", ], "updateTime": "A String", # Output only. The last update timestamp of the log scope. @@ -204,8 +204,8 @@

Method Details

{ # Describes a group of resources to read log entries from. "createTime": "A String", # Output only. The creation timestamp of the log scope. "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters. - "name": "A String", # Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope - "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total. + "name": "A String", # Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope + "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total. "A String", ], "updateTime": "A String", # Output only. The last update timestamp of the log scope. @@ -234,15 +234,15 @@

Method Details

Updates a log scope.
 
 Args:
-  name: string, Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope (required)
+  name: string, Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Describes a group of resources to read log entries from.
   "createTime": "A String", # Output only. The creation timestamp of the log scope.
   "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters.
-  "name": "A String", # Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope
-  "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total.
+  "name": "A String", # Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope
+  "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total.
     "A String",
   ],
   "updateTime": "A String", # Output only. The last update timestamp of the log scope.
@@ -260,8 +260,8 @@ 

Method Details

{ # Describes a group of resources to read log entries from. "createTime": "A String", # Output only. The creation timestamp of the log scope. "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters. - "name": "A String", # Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope - "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total. + "name": "A String", # Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope + "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total. "A String", ], "updateTime": "A String", # Output only. The last update timestamp of the log scope. diff --git a/docs/dyn/logging_v2.projects.locations.logScopes.html b/docs/dyn/logging_v2.projects.locations.logScopes.html index d6e2da10a2..77f80e3531 100644 --- a/docs/dyn/logging_v2.projects.locations.logScopes.html +++ b/docs/dyn/logging_v2.projects.locations.logScopes.html @@ -113,8 +113,8 @@

Method Details

{ # Describes a group of resources to read log entries from. "createTime": "A String", # Output only. The creation timestamp of the log scope. "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters. - "name": "A String", # Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope - "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total. + "name": "A String", # Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope + "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total. "A String", ], "updateTime": "A String", # Output only. The last update timestamp of the log scope. @@ -132,8 +132,8 @@

Method Details

{ # Describes a group of resources to read log entries from. "createTime": "A String", # Output only. The creation timestamp of the log scope. "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters. - "name": "A String", # Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope - "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total. + "name": "A String", # Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope + "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total. "A String", ], "updateTime": "A String", # Output only. The last update timestamp of the log scope. @@ -175,8 +175,8 @@

Method Details

{ # Describes a group of resources to read log entries from. "createTime": "A String", # Output only. The creation timestamp of the log scope. "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters. - "name": "A String", # Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope - "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total. + "name": "A String", # Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope + "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total. "A String", ], "updateTime": "A String", # Output only. The last update timestamp of the log scope. @@ -204,8 +204,8 @@

Method Details

{ # Describes a group of resources to read log entries from. "createTime": "A String", # Output only. The creation timestamp of the log scope. "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters. - "name": "A String", # Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope - "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total. + "name": "A String", # Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope + "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total. "A String", ], "updateTime": "A String", # Output only. The last update timestamp of the log scope. @@ -234,15 +234,15 @@

Method Details

Updates a log scope.
 
 Args:
-  name: string, Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope (required)
+  name: string, Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Describes a group of resources to read log entries from.
   "createTime": "A String", # Output only. The creation timestamp of the log scope.
   "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters.
-  "name": "A String", # Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope
-  "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total.
+  "name": "A String", # Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope
+  "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total.
     "A String",
   ],
   "updateTime": "A String", # Output only. The last update timestamp of the log scope.
@@ -260,8 +260,8 @@ 

Method Details

{ # Describes a group of resources to read log entries from. "createTime": "A String", # Output only. The creation timestamp of the log scope. "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters. - "name": "A String", # Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope - "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total. + "name": "A String", # Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope + "resourceNames": [ # Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total. "A String", ], "updateTime": "A String", # Output only. The last update timestamp of the log scope. diff --git a/docs/dyn/looker_v1.projects.locations.instances.html b/docs/dyn/looker_v1.projects.locations.instances.html index c26a4dcee7..b4b5426aca 100644 --- a/docs/dyn/looker_v1.projects.locations.instances.html +++ b/docs/dyn/looker_v1.projects.locations.instances.html @@ -157,10 +157,10 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts and ends. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "egressPublicIp": "A String", # Output only. Public Egress IP (IPv4). @@ -185,10 +185,10 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts and ends. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "linkedLspProjectNumber": "A String", # Optional. Linked Google Cloud Project Number for Looker Studio Pro. @@ -201,10 +201,10 @@

Method Details

"maintenanceWindow": { # Specifies the recurring maintenance window. # Maintenance window for this instance. "dayOfWeek": "A String", # Required. Day of the week for this MaintenanceWindow (in UTC). "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts. Maintenance will be scheduled within 60 minutes. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "name": "A String", # Output only. Format: `projects/{project}/locations/{location}/instances/{instance}`. @@ -388,10 +388,10 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts and ends. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "egressPublicIp": "A String", # Output only. Public Egress IP (IPv4). @@ -416,10 +416,10 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts and ends. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "linkedLspProjectNumber": "A String", # Optional. Linked Google Cloud Project Number for Looker Studio Pro. @@ -432,10 +432,10 @@

Method Details

"maintenanceWindow": { # Specifies the recurring maintenance window. # Maintenance window for this instance. "dayOfWeek": "A String", # Required. Day of the week for this MaintenanceWindow (in UTC). "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts. Maintenance will be scheduled within 60 minutes. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "name": "A String", # Output only. Format: `projects/{project}/locations/{location}/instances/{instance}`. @@ -603,10 +603,10 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts and ends. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "egressPublicIp": "A String", # Output only. Public Egress IP (IPv4). @@ -631,10 +631,10 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts and ends. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "linkedLspProjectNumber": "A String", # Optional. Linked Google Cloud Project Number for Looker Studio Pro. @@ -647,10 +647,10 @@

Method Details

"maintenanceWindow": { # Specifies the recurring maintenance window. # Maintenance window for this instance. "dayOfWeek": "A String", # Required. Day of the week for this MaintenanceWindow (in UTC). "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts. Maintenance will be scheduled within 60 minutes. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "name": "A String", # Output only. Format: `projects/{project}/locations/{location}/instances/{instance}`. @@ -739,10 +739,10 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts and ends. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "egressPublicIp": "A String", # Output only. Public Egress IP (IPv4). @@ -767,10 +767,10 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts and ends. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "linkedLspProjectNumber": "A String", # Optional. Linked Google Cloud Project Number for Looker Studio Pro. @@ -783,10 +783,10 @@

Method Details

"maintenanceWindow": { # Specifies the recurring maintenance window. # Maintenance window for this instance. "dayOfWeek": "A String", # Required. Day of the week for this MaintenanceWindow (in UTC). "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts. Maintenance will be scheduled within 60 minutes. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "name": "A String", # Output only. Format: `projects/{project}/locations/{location}/instances/{instance}`. diff --git a/docs/dyn/memcache_v1.projects.locations.instances.html b/docs/dyn/memcache_v1.projects.locations.instances.html index 0bb8428c1e..a29c315bd1 100644 --- a/docs/dyn/memcache_v1.projects.locations.instances.html +++ b/docs/dyn/memcache_v1.projects.locations.instances.html @@ -190,10 +190,10 @@

Method Details

"day": "A String", # Required. Allows to define schedule that runs specified day of the week. "duration": "A String", # Required. Duration of the time window. "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Start time of the window in UTC. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, ], @@ -348,10 +348,10 @@

Method Details

"day": "A String", # Required. Allows to define schedule that runs specified day of the week. "duration": "A String", # Required. Duration of the time window. "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Start time of the window in UTC. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, ], @@ -448,10 +448,10 @@

Method Details

"day": "A String", # Required. Allows to define schedule that runs specified day of the week. "duration": "A String", # Required. Duration of the time window. "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Start time of the window in UTC. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, ], @@ -557,10 +557,10 @@

Method Details

"day": "A String", # Required. Allows to define schedule that runs specified day of the week. "duration": "A String", # Required. Duration of the time window. "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Start time of the window in UTC. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, ], diff --git a/docs/dyn/memcache_v1beta2.projects.locations.instances.html b/docs/dyn/memcache_v1beta2.projects.locations.instances.html index 781c763357..4605cc1eb9 100644 --- a/docs/dyn/memcache_v1beta2.projects.locations.instances.html +++ b/docs/dyn/memcache_v1beta2.projects.locations.instances.html @@ -238,10 +238,10 @@

Method Details

"day": "A String", # Required. Allows to define schedule that runs specified day of the week. "duration": "A String", # Required. Duration of the time window. "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Start time of the window in UTC. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, ], @@ -398,10 +398,10 @@

Method Details

"day": "A String", # Required. Allows to define schedule that runs specified day of the week. "duration": "A String", # Required. Duration of the time window. "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Start time of the window in UTC. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, ], @@ -501,10 +501,10 @@

Method Details

"day": "A String", # Required. Allows to define schedule that runs specified day of the week. "duration": "A String", # Required. Duration of the time window. "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Start time of the window in UTC. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, ], @@ -611,10 +611,10 @@

Method Details

"day": "A String", # Required. Allows to define schedule that runs specified day of the week. "duration": "A String", # Required. Duration of the time window. "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Start time of the window in UTC. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, ], diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.businessIdentity.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.businessIdentity.html index 5094ee1445..9f04ed0ffb 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.businessIdentity.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.businessIdentity.html @@ -153,7 +153,7 @@

Method Details

}, } - updateMask: string, Required. List of fields being updated. + updateMask: string, Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `black_owned` - `latino_owned` - `promotions_consent` - `small_business` - `veteran_owned` - `women_owned` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html index beb72d5de5..cfe8c50a5d 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html @@ -199,7 +199,7 @@

Method Details

"phoneVerificationState": "A String", # Output only. The phone verification state of the business. } - updateMask: string, Required. List of fields being updated. + updateMask: string, Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `address` - `customer_service` - `korean_business_registration_number` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.emailPreferences.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.emailPreferences.html index 952a7532ca..36e1018824 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.emailPreferences.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.emailPreferences.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

getEmailPreferences(name, x__xgafv=None)

-

Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.

+

Returns the email preferences for a Merchant Center account user. This service only permits retrieving and updating email preferences for the authenticated user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.

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

Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.

@@ -91,7 +91,7 @@

Method Details

getEmailPreferences(name, x__xgafv=None) -
Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.
+  
Returns the email preferences for a Merchant Center account user. This service only permits retrieving and updating email preferences for the authenticated user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.
 
 Args:
   name: string, Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences` (required)
@@ -123,7 +123,7 @@ 

Method Details

"newsAndTips": "A String", # Optional. Updates on new features, tips and best practices. } - updateMask: string, Required. List of fields being updated. + updateMask: string, Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `news_and_tips` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.homepage.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.homepage.html index fc15b04da3..7bce9f12df 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.homepage.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.homepage.html @@ -100,6 +100,7 @@

Method Details

The object takes the form of: { # Request message for the `ClaimHomepage` method. + "overwrite": True or False, # Optional. When set to `true`, this option removes any existing claim on the requested website and replaces it with a claim from the account that makes the request. } x__xgafv: string, V1 error format. @@ -185,7 +186,7 @@

Method Details

"uri": "A String", # Required. The URI (typically a URL) of the store's homepage. } - updateMask: string, Required. List of fields being updated. + updateMask: string, Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `uri` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.html index c088f6fdb9..02d35614c5 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.html @@ -192,7 +192,7 @@

Method Details

{ # Additional instructions to add account services during creation of the account. "accountAggregation": { # `AccountAggregation` payload. # The provider is an [aggregator](https://support.google.com/merchants/answer/188487) for the account. Payload for service type Account Aggregation. }, - "provider": "A String", # Optional. The provider of the service. Format: `accounts/{account}` + "provider": "A String", # Required. The provider of the service. Format: `accounts/{account}` }, ], "users": [ # Optional. Users to be added to the account. @@ -399,7 +399,7 @@

Method Details

}, } - updateMask: string, Required. List of fields being updated. + updateMask: string, Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `account_name` - `adult_content` - `language_code` - `time_zone` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html index 004831fec6..e91553645f 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html @@ -82,7 +82,7 @@

Instance Methods

Creates a Merchant Center account user. Executing this method requires admin access.

delete(name, x__xgafv=None)

-

Deletes a Merchant Center account user. Executing this method requires admin access.

+

Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account. Also a user is protected from deletion if it is managed by Business Manager"

get(name, x__xgafv=None)

Retrieves a Merchant Center account user.

@@ -138,7 +138,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a Merchant Center account user. Executing this method requires admin access.
+  
Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account. Also a user is protected from deletion if it is managed by Business Manager"
 
 Args:
   name: string, Required. The name of the user to delete. Format: `accounts/{account}/users/{email}` It is also possible to delete the user corresponding to the caller by using `me` rather than an email address as in `accounts/{account}/users/me`. (required)
@@ -238,7 +238,7 @@ 

Method Details

"state": "A String", # Output only. The state of the user. } - updateMask: string, Required. List of fields being updated. + updateMask: string, Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `access_rights` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/merchantapi_conversions_v1beta.accounts.conversionSources.html b/docs/dyn/merchantapi_conversions_v1beta.accounts.conversionSources.html index 9885715f72..ce3f9e9b18 100644 --- a/docs/dyn/merchantapi_conversions_v1beta.accounts.conversionSources.html +++ b/docs/dyn/merchantapi_conversions_v1beta.accounts.conversionSources.html @@ -381,7 +381,7 @@

Method Details

"state": "A String", # Output only. Current state of this conversion source. Can't be edited through the API. } - updateMask: string, Required. List of fields being updated. + updateMask: string, Optional. List of fields being updated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/merchantapi_datasources_v1beta.accounts.dataSources.html b/docs/dyn/merchantapi_datasources_v1beta.accounts.dataSources.html index 9581d15668..35c5d1fbd7 100644 --- a/docs/dyn/merchantapi_datasources_v1beta.accounts.dataSources.html +++ b/docs/dyn/merchantapi_datasources_v1beta.accounts.dataSources.html @@ -146,6 +146,8 @@

Method Details

"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). }, + "merchantReviewDataSource": { # The merchant review data source. # Required. The [merchant review](https://support.google.com/merchants/answer/7045996) data source. + }, "name": "A String", # Identifier. The name of the data source. Format: `{datasource.name=accounts/{account}/dataSources/{datasource}}` "primaryProductDataSource": { # The primary data source for local and online products. # Required. The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products. "channel": "A String", # Required. Immutable. Specifies the type of data source channel. @@ -164,6 +166,8 @@

Method Details

}, "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. }, + "productReviewDataSource": { # The product review data source. # Required. The [product review](https://support.google.com/merchants/answer/7045996) data source. + }, "promotionDataSource": { # The promotion data source. # Required. The [promotion](https://support.google.com/merchants/answer/2906014) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items in the data source. "targetCountry": "A String", # Required. Immutable. The target country used as part of the unique identifier. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). Promotions are only available in selected [countries](https://support.google.com/merchants/answer/4588460). @@ -174,7 +178,7 @@

Method Details

}, "supplementalProductDataSource": { # The supplemental data source for local and online products. After creation, you should make sure to link the supplemental product data source into one or more primary product data sources. # Required. The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` @@ -221,6 +225,8 @@

Method Details

"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). }, + "merchantReviewDataSource": { # The merchant review data source. # Required. The [merchant review](https://support.google.com/merchants/answer/7045996) data source. + }, "name": "A String", # Identifier. The name of the data source. Format: `{datasource.name=accounts/{account}/dataSources/{datasource}}` "primaryProductDataSource": { # The primary data source for local and online products. # Required. The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products. "channel": "A String", # Required. Immutable. Specifies the type of data source channel. @@ -239,6 +245,8 @@

Method Details

}, "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. }, + "productReviewDataSource": { # The product review data source. # Required. The [product review](https://support.google.com/merchants/answer/7045996) data source. + }, "promotionDataSource": { # The promotion data source. # Required. The [promotion](https://support.google.com/merchants/answer/2906014) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items in the data source. "targetCountry": "A String", # Required. Immutable. The target country used as part of the unique identifier. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). Promotions are only available in selected [countries](https://support.google.com/merchants/answer/4588460). @@ -249,7 +257,7 @@

Method Details

}, "supplementalProductDataSource": { # The supplemental data source for local and online products. After creation, you should make sure to link the supplemental product data source into one or more primary product data sources. # Required. The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` @@ -345,6 +353,8 @@

Method Details

"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). }, + "merchantReviewDataSource": { # The merchant review data source. # Required. The [merchant review](https://support.google.com/merchants/answer/7045996) data source. + }, "name": "A String", # Identifier. The name of the data source. Format: `{datasource.name=accounts/{account}/dataSources/{datasource}}` "primaryProductDataSource": { # The primary data source for local and online products. # Required. The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products. "channel": "A String", # Required. Immutable. Specifies the type of data source channel. @@ -363,6 +373,8 @@

Method Details

}, "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. }, + "productReviewDataSource": { # The product review data source. # Required. The [product review](https://support.google.com/merchants/answer/7045996) data source. + }, "promotionDataSource": { # The promotion data source. # Required. The [promotion](https://support.google.com/merchants/answer/2906014) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items in the data source. "targetCountry": "A String", # Required. Immutable. The target country used as part of the unique identifier. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). Promotions are only available in selected [countries](https://support.google.com/merchants/answer/4588460). @@ -373,7 +385,7 @@

Method Details

}, "supplementalProductDataSource": { # The supplemental data source for local and online products. After creation, you should make sure to link the supplemental product data source into one or more primary product data sources. # Required. The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` @@ -431,6 +443,8 @@

Method Details

"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). }, + "merchantReviewDataSource": { # The merchant review data source. # Required. The [merchant review](https://support.google.com/merchants/answer/7045996) data source. + }, "name": "A String", # Identifier. The name of the data source. Format: `{datasource.name=accounts/{account}/dataSources/{datasource}}` "primaryProductDataSource": { # The primary data source for local and online products. # Required. The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products. "channel": "A String", # Required. Immutable. Specifies the type of data source channel. @@ -449,6 +463,8 @@

Method Details

}, "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. }, + "productReviewDataSource": { # The product review data source. # Required. The [product review](https://support.google.com/merchants/answer/7045996) data source. + }, "promotionDataSource": { # The promotion data source. # Required. The [promotion](https://support.google.com/merchants/answer/2906014) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items in the data source. "targetCountry": "A String", # Required. Immutable. The target country used as part of the unique identifier. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). Promotions are only available in selected [countries](https://support.google.com/merchants/answer/4588460). @@ -459,7 +475,7 @@

Method Details

}, "supplementalProductDataSource": { # The supplemental data source for local and online products. After creation, you should make sure to link the supplemental product data source into one or more primary product data sources. # Required. The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` @@ -525,6 +541,8 @@

Method Details

"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). }, + "merchantReviewDataSource": { # The merchant review data source. # Required. The [merchant review](https://support.google.com/merchants/answer/7045996) data source. + }, "name": "A String", # Identifier. The name of the data source. Format: `{datasource.name=accounts/{account}/dataSources/{datasource}}` "primaryProductDataSource": { # The primary data source for local and online products. # Required. The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products. "channel": "A String", # Required. Immutable. Specifies the type of data source channel. @@ -543,6 +561,8 @@

Method Details

}, "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. }, + "productReviewDataSource": { # The product review data source. # Required. The [product review](https://support.google.com/merchants/answer/7045996) data source. + }, "promotionDataSource": { # The promotion data source. # Required. The [promotion](https://support.google.com/merchants/answer/2906014) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items in the data source. "targetCountry": "A String", # Required. Immutable. The target country used as part of the unique identifier. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). Promotions are only available in selected [countries](https://support.google.com/merchants/answer/4588460). @@ -553,7 +573,7 @@

Method Details

}, "supplementalProductDataSource": { # The supplemental data source for local and online products. After creation, you should make sure to link the supplemental product data source into one or more primary product data sources. # Required. The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` @@ -601,6 +621,8 @@

Method Details

"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). }, + "merchantReviewDataSource": { # The merchant review data source. # Required. The [merchant review](https://support.google.com/merchants/answer/7045996) data source. + }, "name": "A String", # Identifier. The name of the data source. Format: `{datasource.name=accounts/{account}/dataSources/{datasource}}` "primaryProductDataSource": { # The primary data source for local and online products. # Required. The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products. "channel": "A String", # Required. Immutable. Specifies the type of data source channel. @@ -619,6 +641,8 @@

Method Details

}, "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. }, + "productReviewDataSource": { # The product review data source. # Required. The [product review](https://support.google.com/merchants/answer/7045996) data source. + }, "promotionDataSource": { # The promotion data source. # Required. The [promotion](https://support.google.com/merchants/answer/2906014) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items in the data source. "targetCountry": "A String", # Required. Immutable. The target country used as part of the unique identifier. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). Promotions are only available in selected [countries](https://support.google.com/merchants/answer/4588460). @@ -629,7 +653,7 @@

Method Details

}, "supplementalProductDataSource": { # The supplemental data source for local and online products. After creation, you should make sure to link the supplemental product data source into one or more primary product data sources. # Required. The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html index 6ecb9be5ad..d72ce22fea 100644 --- a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html +++ b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html @@ -94,7 +94,7 @@

Method Details

Deletes a product input from your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
 
 Args:
-  name: string, Required. The name of the product input resource to delete. Format: accounts/{account}/productInputs/{product} (required)
+  name: string, Required. The name of the product input resource to delete. Format: accounts/{account}/productInputs/{product} where the last section `product` consists of 4 parts: channel~content_language~feed_label~offer_id example for product name is "accounts/123/productInputs/online~en~US~sku123" (required)
   dataSource: string, Required. The primary or supplemental data source from which the product input should be deleted. Format: `accounts/{account}/dataSources/{datasource}`.
   x__xgafv: string, V1 error format.
     Allowed values
diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.products.html b/docs/dyn/merchantapi_products_v1beta.accounts.products.html
index 7c3e30e2e9..27e3e505d5 100644
--- a/docs/dyn/merchantapi_products_v1beta.accounts.products.html
+++ b/docs/dyn/merchantapi_products_v1beta.accounts.products.html
@@ -97,7 +97,7 @@ 

Method Details

Retrieves the processed product from your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.
 
 Args:
-  name: string, Required. The name of the product to retrieve. Format: `accounts/{account}/products/{product}` (required)
+  name: string, Required. The name of the product to retrieve. Format: `accounts/{account}/products/{product}` where the last section `product` consists of 4 parts: channel~content_language~feed_label~offer_id example for product name is "accounts/123/products/online~en~US~sku123" (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/merchantapi_reviews_v1beta.accounts.html b/docs/dyn/merchantapi_reviews_v1beta.accounts.html
new file mode 100644
index 0000000000..9c5d4d3e7b
--- /dev/null
+++ b/docs/dyn/merchantapi_reviews_v1beta.accounts.html
@@ -0,0 +1,96 @@
+
+
+
+

Merchant API . accounts

+

Instance Methods

+

+ merchantReviews() +

+

Returns the merchantReviews Resource.

+ +

+ productReviews() +

+

Returns the productReviews Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/merchantapi_reviews_v1beta.accounts.merchantReviews.html b/docs/dyn/merchantapi_reviews_v1beta.accounts.merchantReviews.html new file mode 100644 index 0000000000..722e7ef3d2 --- /dev/null +++ b/docs/dyn/merchantapi_reviews_v1beta.accounts.merchantReviews.html @@ -0,0 +1,405 @@ + + + +

Merchant API . accounts . merchantReviews

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes merchant review.

+

+ get(name, x__xgafv=None)

+

Gets a merchant review.

+

+ insert(parent, body=None, dataSource=None, x__xgafv=None)

+

Inserts a review for your Merchant Center account. If the review already exists, then the review is replaced with the new instance.

+

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

+

Lists merchant reviews.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes merchant review.
+
+Args:
+  name: string, Required. The ID of the merchant review. Format: accounts/{account}/merchantReviews/{merchantReview} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a merchant review.
+
+Args:
+  name: string, Required. The ID of the merchant review. Format: accounts/{account}/merchantReviews/{merchantReview} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A review for a merchant. For more information, see [Introduction to Merchant Review Feeds](https://developers.google.com/merchant-review-feeds)
+  "attributes": { # Attributes. # Optional. A list of merchant review attributes.
+    "collectionMethod": "A String", # Optional. The method used to collect the review.
+    "content": "A String", # Required. This should be any freeform text provided by the user and should not be truncated. If multiple responses to different questions are provided, all responses should be included, with the minimal context for the responses to make sense. Context should not be provided if questions were left unanswered.
+    "isAnonymous": True or False, # Optional. Set to true if the reviewer should remain anonymous.
+    "maxRating": "A String", # Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min rating.
+    "merchantDisplayName": "A String", # Optional. Human-readable display name for the merchant.
+    "merchantId": "A String", # Required. Must be unique and stable across all requests. In other words, if a request today and another 90 days ago refer to the same merchant, they must have the same id.
+    "merchantLink": "A String", # Optional. URL to the merchant's main website. Do not use a redirect URL for this value. In other words, the value should point directly to the merchant's site.
+    "merchantRatingLink": "A String", # Optional. URL to the landing page that hosts the reviews for this merchant. Do not use a redirect URL.
+    "minRating": "A String", # Optional. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.
+    "rating": 3.14, # Optional. The reviewer's overall rating of the merchant.
+    "reviewCountry": "A String", # Optional. The country where the reviewer made the order defined by ISO 3166-1 Alpha-2 Country Code.
+    "reviewLanguage": "A String", # Required. The language of the review defined by BCP-47 language code.
+    "reviewTime": "A String", # Required. The timestamp indicating when the review was written.
+    "reviewerId": "A String", # Optional. A permanent, unique identifier for the author of the review in the publisher's system.
+    "reviewerUsername": "A String", # Optional. Display name of the review author.
+    "title": "A String", # Optional. The title of the review.
+  },
+  "customAttributes": [ # Required. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion.
+    { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
+      "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
+        # Object with schema name: CustomAttribute
+      ],
+      "name": "A String", # The name of the attribute.
+      "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
+    },
+  ],
+  "dataSource": "A String", # Output only. The primary data source of the merchant review.
+  "merchantReviewId": "A String", # Required. The user provided merchant review ID to uniquely identify the merchant review.
+  "merchantReviewStatus": { # The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously. # Output only. The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously.
+    "createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+    "destinationStatuses": [ # Output only. The intended destinations for the merchant review.
+      { # The destination status of the merchant review status.
+        "reportingContext": "A String", # Output only. The name of the reporting context.
+      },
+    ],
+    "itemLevelIssues": [ # Output only. A list of all issues associated with the merchant review.
+      { # The ItemLevelIssue of the merchant review status.
+        "attribute": "A String", # Output only. The attribute's name, if the issue is caused by a single attribute.
+        "code": "A String", # Output only. The error code of the issue.
+        "description": "A String", # Output only. A short issue description in English.
+        "detail": "A String", # Output only. A detailed issue description in English.
+        "documentation": "A String", # Output only. The URL of a web page to help with resolving this issue.
+        "reportingContext": "A String", # Output only. The reporting context the issue applies to.
+        "resolution": "A String", # Output only. Whether the issue can be resolved by the merchant.
+        "severity": "A String", # Output only. How this issue affects serving of the merchant review.
+      },
+    ],
+    "lastUpdateTime": "A String", # Output only. Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+  },
+  "name": "A String", # Identifier. The name of the merchant review. Format: `"{merchantreview.name=accounts/{account}/merchantReviews/{merchantReview}}"`
+}
+
+ +
+ insert(parent, body=None, dataSource=None, x__xgafv=None) +
Inserts a review for your Merchant Center account. If the review already exists, then the review is replaced with the new instance.
+
+Args:
+  parent: string, Required. The account where the merchant review will be inserted. Format: accounts/{account} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A review for a merchant. For more information, see [Introduction to Merchant Review Feeds](https://developers.google.com/merchant-review-feeds)
+  "attributes": { # Attributes. # Optional. A list of merchant review attributes.
+    "collectionMethod": "A String", # Optional. The method used to collect the review.
+    "content": "A String", # Required. This should be any freeform text provided by the user and should not be truncated. If multiple responses to different questions are provided, all responses should be included, with the minimal context for the responses to make sense. Context should not be provided if questions were left unanswered.
+    "isAnonymous": True or False, # Optional. Set to true if the reviewer should remain anonymous.
+    "maxRating": "A String", # Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min rating.
+    "merchantDisplayName": "A String", # Optional. Human-readable display name for the merchant.
+    "merchantId": "A String", # Required. Must be unique and stable across all requests. In other words, if a request today and another 90 days ago refer to the same merchant, they must have the same id.
+    "merchantLink": "A String", # Optional. URL to the merchant's main website. Do not use a redirect URL for this value. In other words, the value should point directly to the merchant's site.
+    "merchantRatingLink": "A String", # Optional. URL to the landing page that hosts the reviews for this merchant. Do not use a redirect URL.
+    "minRating": "A String", # Optional. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.
+    "rating": 3.14, # Optional. The reviewer's overall rating of the merchant.
+    "reviewCountry": "A String", # Optional. The country where the reviewer made the order defined by ISO 3166-1 Alpha-2 Country Code.
+    "reviewLanguage": "A String", # Required. The language of the review defined by BCP-47 language code.
+    "reviewTime": "A String", # Required. The timestamp indicating when the review was written.
+    "reviewerId": "A String", # Optional. A permanent, unique identifier for the author of the review in the publisher's system.
+    "reviewerUsername": "A String", # Optional. Display name of the review author.
+    "title": "A String", # Optional. The title of the review.
+  },
+  "customAttributes": [ # Required. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion.
+    { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
+      "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
+        # Object with schema name: CustomAttribute
+      ],
+      "name": "A String", # The name of the attribute.
+      "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
+    },
+  ],
+  "dataSource": "A String", # Output only. The primary data source of the merchant review.
+  "merchantReviewId": "A String", # Required. The user provided merchant review ID to uniquely identify the merchant review.
+  "merchantReviewStatus": { # The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously. # Output only. The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously.
+    "createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+    "destinationStatuses": [ # Output only. The intended destinations for the merchant review.
+      { # The destination status of the merchant review status.
+        "reportingContext": "A String", # Output only. The name of the reporting context.
+      },
+    ],
+    "itemLevelIssues": [ # Output only. A list of all issues associated with the merchant review.
+      { # The ItemLevelIssue of the merchant review status.
+        "attribute": "A String", # Output only. The attribute's name, if the issue is caused by a single attribute.
+        "code": "A String", # Output only. The error code of the issue.
+        "description": "A String", # Output only. A short issue description in English.
+        "detail": "A String", # Output only. A detailed issue description in English.
+        "documentation": "A String", # Output only. The URL of a web page to help with resolving this issue.
+        "reportingContext": "A String", # Output only. The reporting context the issue applies to.
+        "resolution": "A String", # Output only. Whether the issue can be resolved by the merchant.
+        "severity": "A String", # Output only. How this issue affects serving of the merchant review.
+      },
+    ],
+    "lastUpdateTime": "A String", # Output only. Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+  },
+  "name": "A String", # Identifier. The name of the merchant review. Format: `"{merchantreview.name=accounts/{account}/merchantReviews/{merchantReview}}"`
+}
+
+  dataSource: string, Required. The data source of the [merchantreview](https://support.google.com/merchants/answer/7045996?sjid=5253581244217581976-EU) Format: `accounts/{account}/dataSources/{datasource}`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A review for a merchant. For more information, see [Introduction to Merchant Review Feeds](https://developers.google.com/merchant-review-feeds)
+  "attributes": { # Attributes. # Optional. A list of merchant review attributes.
+    "collectionMethod": "A String", # Optional. The method used to collect the review.
+    "content": "A String", # Required. This should be any freeform text provided by the user and should not be truncated. If multiple responses to different questions are provided, all responses should be included, with the minimal context for the responses to make sense. Context should not be provided if questions were left unanswered.
+    "isAnonymous": True or False, # Optional. Set to true if the reviewer should remain anonymous.
+    "maxRating": "A String", # Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min rating.
+    "merchantDisplayName": "A String", # Optional. Human-readable display name for the merchant.
+    "merchantId": "A String", # Required. Must be unique and stable across all requests. In other words, if a request today and another 90 days ago refer to the same merchant, they must have the same id.
+    "merchantLink": "A String", # Optional. URL to the merchant's main website. Do not use a redirect URL for this value. In other words, the value should point directly to the merchant's site.
+    "merchantRatingLink": "A String", # Optional. URL to the landing page that hosts the reviews for this merchant. Do not use a redirect URL.
+    "minRating": "A String", # Optional. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.
+    "rating": 3.14, # Optional. The reviewer's overall rating of the merchant.
+    "reviewCountry": "A String", # Optional. The country where the reviewer made the order defined by ISO 3166-1 Alpha-2 Country Code.
+    "reviewLanguage": "A String", # Required. The language of the review defined by BCP-47 language code.
+    "reviewTime": "A String", # Required. The timestamp indicating when the review was written.
+    "reviewerId": "A String", # Optional. A permanent, unique identifier for the author of the review in the publisher's system.
+    "reviewerUsername": "A String", # Optional. Display name of the review author.
+    "title": "A String", # Optional. The title of the review.
+  },
+  "customAttributes": [ # Required. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion.
+    { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
+      "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
+        # Object with schema name: CustomAttribute
+      ],
+      "name": "A String", # The name of the attribute.
+      "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
+    },
+  ],
+  "dataSource": "A String", # Output only. The primary data source of the merchant review.
+  "merchantReviewId": "A String", # Required. The user provided merchant review ID to uniquely identify the merchant review.
+  "merchantReviewStatus": { # The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously. # Output only. The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously.
+    "createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+    "destinationStatuses": [ # Output only. The intended destinations for the merchant review.
+      { # The destination status of the merchant review status.
+        "reportingContext": "A String", # Output only. The name of the reporting context.
+      },
+    ],
+    "itemLevelIssues": [ # Output only. A list of all issues associated with the merchant review.
+      { # The ItemLevelIssue of the merchant review status.
+        "attribute": "A String", # Output only. The attribute's name, if the issue is caused by a single attribute.
+        "code": "A String", # Output only. The error code of the issue.
+        "description": "A String", # Output only. A short issue description in English.
+        "detail": "A String", # Output only. A detailed issue description in English.
+        "documentation": "A String", # Output only. The URL of a web page to help with resolving this issue.
+        "reportingContext": "A String", # Output only. The reporting context the issue applies to.
+        "resolution": "A String", # Output only. Whether the issue can be resolved by the merchant.
+        "severity": "A String", # Output only. How this issue affects serving of the merchant review.
+      },
+    ],
+    "lastUpdateTime": "A String", # Output only. Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+  },
+  "name": "A String", # Identifier. The name of the merchant review. Format: `"{merchantreview.name=accounts/{account}/merchantReviews/{merchantReview}}"`
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists merchant reviews.
+
+Args:
+  parent: string, Required. The account to list merchant reviews for. Format: accounts/{account} (required)
+  pageSize: integer, Optional. The maximum number of merchant reviews to return. The service can return fewer than this value. The maximum value is 1000; values above 1000 are coerced to 1000. If unspecified, the maximum number of reviews is returned.
+  pageToken: string, Optional. A page token, received from a previous `ListMerchantReviews` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMerchantReviews` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for the `ListMerchantsReview` method.
+  "merchantReviews": [ # The merchant review.
+    { # A review for a merchant. For more information, see [Introduction to Merchant Review Feeds](https://developers.google.com/merchant-review-feeds)
+      "attributes": { # Attributes. # Optional. A list of merchant review attributes.
+        "collectionMethod": "A String", # Optional. The method used to collect the review.
+        "content": "A String", # Required. This should be any freeform text provided by the user and should not be truncated. If multiple responses to different questions are provided, all responses should be included, with the minimal context for the responses to make sense. Context should not be provided if questions were left unanswered.
+        "isAnonymous": True or False, # Optional. Set to true if the reviewer should remain anonymous.
+        "maxRating": "A String", # Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min rating.
+        "merchantDisplayName": "A String", # Optional. Human-readable display name for the merchant.
+        "merchantId": "A String", # Required. Must be unique and stable across all requests. In other words, if a request today and another 90 days ago refer to the same merchant, they must have the same id.
+        "merchantLink": "A String", # Optional. URL to the merchant's main website. Do not use a redirect URL for this value. In other words, the value should point directly to the merchant's site.
+        "merchantRatingLink": "A String", # Optional. URL to the landing page that hosts the reviews for this merchant. Do not use a redirect URL.
+        "minRating": "A String", # Optional. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.
+        "rating": 3.14, # Optional. The reviewer's overall rating of the merchant.
+        "reviewCountry": "A String", # Optional. The country where the reviewer made the order defined by ISO 3166-1 Alpha-2 Country Code.
+        "reviewLanguage": "A String", # Required. The language of the review defined by BCP-47 language code.
+        "reviewTime": "A String", # Required. The timestamp indicating when the review was written.
+        "reviewerId": "A String", # Optional. A permanent, unique identifier for the author of the review in the publisher's system.
+        "reviewerUsername": "A String", # Optional. Display name of the review author.
+        "title": "A String", # Optional. The title of the review.
+      },
+      "customAttributes": [ # Required. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion.
+        { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
+          "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
+            # Object with schema name: CustomAttribute
+          ],
+          "name": "A String", # The name of the attribute.
+          "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
+        },
+      ],
+      "dataSource": "A String", # Output only. The primary data source of the merchant review.
+      "merchantReviewId": "A String", # Required. The user provided merchant review ID to uniquely identify the merchant review.
+      "merchantReviewStatus": { # The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously. # Output only. The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously.
+        "createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+        "destinationStatuses": [ # Output only. The intended destinations for the merchant review.
+          { # The destination status of the merchant review status.
+            "reportingContext": "A String", # Output only. The name of the reporting context.
+          },
+        ],
+        "itemLevelIssues": [ # Output only. A list of all issues associated with the merchant review.
+          { # The ItemLevelIssue of the merchant review status.
+            "attribute": "A String", # Output only. The attribute's name, if the issue is caused by a single attribute.
+            "code": "A String", # Output only. The error code of the issue.
+            "description": "A String", # Output only. A short issue description in English.
+            "detail": "A String", # Output only. A detailed issue description in English.
+            "documentation": "A String", # Output only. The URL of a web page to help with resolving this issue.
+            "reportingContext": "A String", # Output only. The reporting context the issue applies to.
+            "resolution": "A String", # Output only. Whether the issue can be resolved by the merchant.
+            "severity": "A String", # Output only. How this issue affects serving of the merchant review.
+          },
+        ],
+        "lastUpdateTime": "A String", # Output only. Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+      },
+      "name": "A String", # Identifier. The name of the merchant review. Format: `"{merchantreview.name=accounts/{account}/merchantReviews/{merchantReview}}"`
+    },
+  ],
+  "nextPageToken": "A String", # The token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/merchantapi_reviews_v1beta.accounts.productReviews.html b/docs/dyn/merchantapi_reviews_v1beta.accounts.productReviews.html new file mode 100644 index 0000000000..ea212a1627 --- /dev/null +++ b/docs/dyn/merchantapi_reviews_v1beta.accounts.productReviews.html @@ -0,0 +1,549 @@ + + + +

Merchant API . accounts . productReviews

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a product review.

+

+ get(name, x__xgafv=None)

+

Gets a product review.

+

+ insert(parent, body=None, dataSource=None, x__xgafv=None)

+

Inserts a product review.

+

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

+

Lists product reviews.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a product review.
+
+Args:
+  name: string, Required. The ID of the Product review. Format: accounts/{account}/productReviews/{productReview} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a product review.
+
+Args:
+  name: string, Required. The ID of the merchant review. Format: accounts/{account}/productReviews/{productReview} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A review for a product. For more information, see [Introduction to Product Review Feeds](https://developers.google.com/product-review-feeds)
+  "attributes": { # Attributes. # Optional. A list of product review attributes.
+    "aggregatorName": "A String", # Optional. The name of the aggregator of the product reviews. A publisher may use a reviews aggregator to manage reviews and provide the feeds. This element indicates the use of an aggregator and contains information about the aggregator.
+    "asins": [ # Optional. Contains ASINs (Amazon Standard Identification Numbers) associated with a product.
+      "A String",
+    ],
+    "brands": [ # Optional. Contains brand names associated with a product.
+      "A String",
+    ],
+    "collectionMethod": "A String", # Optional. The method used to collect the review.
+    "cons": [ # Optional. Contains the disadvantages based on the opinion of the reviewer. Omit boilerplate text like "con:" unless it was written by the reviewer.
+      "A String",
+    ],
+    "content": "A String", # Required. The content of the review.
+    "gtins": [ # Optional. Contains GTINs (global trade item numbers) associated with a product. Sub-types of GTINs (e.g. UPC, EAN, ISBN, JAN) are supported.
+      "A String",
+    ],
+    "isSpam": True or False, # Optional. Indicates whether the review is marked as spam in the publisher's system.
+    "maxRating": "A String", # Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min attribute.
+    "minRating": "A String", # Optional. Contains the ratings associated with the review. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.
+    "mpns": [ # Optional. Contains MPNs (manufacturer part numbers) associated with a product.
+      "A String",
+    ],
+    "productLinks": [ # Optional. The URI of the product. This URI can have the same value as the `review_link` element, if the review URI and the product URI are the same.
+      "A String",
+    ],
+    "productNames": [ # Optional. Descriptive name of a product.
+      "A String",
+    ],
+    "pros": [ # Optional. Contains the advantages based on the opinion of the reviewer. Omit boilerplate text like "pro:" unless it was written by the reviewer.
+      "A String",
+    ],
+    "publisherFavicon": "A String", # Optional. A link to the company favicon of the publisher. The image dimensions should be favicon size: 16x16 pixels. The image format should be GIF, JPG or PNG.
+    "publisherName": "A String", # Optional. The name of the publisher of the product reviews. The information about the publisher, which may be a retailer, manufacturer, reviews service company, or any entity that publishes product reviews.
+    "rating": 3.14, # Optional. The reviewer's overall rating of the product.
+    "reviewCountry": "A String", # Optional. The country of the review defined by ISO 3166-1 Alpha-2 Country Code.
+    "reviewLanguage": "A String", # Optional. The language of the review defined by BCP-47 language code.
+    "reviewLink": { # The URI of the review landing page. # Optional. The URI of the review landing page.
+      "link": "A String", # Optional. The URI of the review landing page. For example: `http://www.example.com/review_5.html`.
+      "type": "A String", # Optional. Type of the review URI.
+    },
+    "reviewTime": "A String", # Required. The timestamp indicating when the review was written.
+    "reviewerId": "A String", # Optional. The author of the product review. A permanent, unique identifier for the author of the review in the publisher's system.
+    "reviewerImageLinks": [ # Optional. A URI to an image of the reviewed product created by the review author. The URI does not have to end with an image file extension.
+      "A String",
+    ],
+    "reviewerIsAnonymous": True or False, # Optional. Set to true if the reviewer should remain anonymous.
+    "reviewerUsername": "A String", # Optional. The name of the reviewer of the product review.
+    "skus": [ # Optional. Contains SKUs (stock keeping units) associated with a product. Often this matches the product Offer Id in the product feed.
+      "A String",
+    ],
+    "subclientName": "A String", # Optional. The name of the subclient of the product reviews. The subclient is an identifier of the product review source. It should be equivalent to the directory provided in the file data source path.
+    "title": "A String", # Optional. The title of the review.
+    "transactionId": "A String", # Optional. A permanent, unique identifier for the transaction associated with the review in the publisher's system. This ID can be used to indicate that multiple reviews are associated with the same transaction.
+  },
+  "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes.
+    { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
+      "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
+        # Object with schema name: CustomAttribute
+      ],
+      "name": "A String", # The name of the attribute.
+      "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
+    },
+  ],
+  "dataSource": "A String", # Output only. The primary data source of the product review.
+  "name": "A String", # Identifier. The name of the product review. Format: `"{productreview.name=accounts/{account}/productReviews/{productReview}}"`
+  "productReviewId": "A String", # Required. The permanent, unique identifier for the product review in the publisher’s system.
+  "productReviewStatus": { # Product review status. # Output only. The status of a product review, data validation issues, that is, information about a product review computed asynchronously.
+    "createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+    "destinationStatuses": [ # Output only. The intended destinations for the product review.
+      { # The destination status of the product review status.
+        "reportingContext": "A String", # Output only. The name of the reporting context.
+      },
+    ],
+    "itemLevelIssues": [ # Output only. A list of all issues associated with the product review.
+      { # The ItemLevelIssue of the product review status.
+        "attribute": "A String", # Output only. The attribute's name, if the issue is caused by a single attribute.
+        "code": "A String", # Output only. The error code of the issue.
+        "description": "A String", # Output only. A short issue description in English.
+        "detail": "A String", # Output only. A detailed issue description in English.
+        "documentation": "A String", # Output only. The URL of a web page to help with resolving this issue.
+        "reportingContext": "A String", # Output only. The reporting context the issue applies to.
+        "resolution": "A String", # Output only. Whether the issue can be resolved by the merchant.
+        "severity": "A String", # Output only. How this issue affects serving of the product review.
+      },
+    ],
+    "lastUpdateTime": "A String", # Output only. Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+  },
+}
+
+ +
+ insert(parent, body=None, dataSource=None, x__xgafv=None) +
Inserts a product review.
+
+Args:
+  parent: string, Required. The account where the product review will be inserted. Format: accounts/{account} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A review for a product. For more information, see [Introduction to Product Review Feeds](https://developers.google.com/product-review-feeds)
+  "attributes": { # Attributes. # Optional. A list of product review attributes.
+    "aggregatorName": "A String", # Optional. The name of the aggregator of the product reviews. A publisher may use a reviews aggregator to manage reviews and provide the feeds. This element indicates the use of an aggregator and contains information about the aggregator.
+    "asins": [ # Optional. Contains ASINs (Amazon Standard Identification Numbers) associated with a product.
+      "A String",
+    ],
+    "brands": [ # Optional. Contains brand names associated with a product.
+      "A String",
+    ],
+    "collectionMethod": "A String", # Optional. The method used to collect the review.
+    "cons": [ # Optional. Contains the disadvantages based on the opinion of the reviewer. Omit boilerplate text like "con:" unless it was written by the reviewer.
+      "A String",
+    ],
+    "content": "A String", # Required. The content of the review.
+    "gtins": [ # Optional. Contains GTINs (global trade item numbers) associated with a product. Sub-types of GTINs (e.g. UPC, EAN, ISBN, JAN) are supported.
+      "A String",
+    ],
+    "isSpam": True or False, # Optional. Indicates whether the review is marked as spam in the publisher's system.
+    "maxRating": "A String", # Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min attribute.
+    "minRating": "A String", # Optional. Contains the ratings associated with the review. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.
+    "mpns": [ # Optional. Contains MPNs (manufacturer part numbers) associated with a product.
+      "A String",
+    ],
+    "productLinks": [ # Optional. The URI of the product. This URI can have the same value as the `review_link` element, if the review URI and the product URI are the same.
+      "A String",
+    ],
+    "productNames": [ # Optional. Descriptive name of a product.
+      "A String",
+    ],
+    "pros": [ # Optional. Contains the advantages based on the opinion of the reviewer. Omit boilerplate text like "pro:" unless it was written by the reviewer.
+      "A String",
+    ],
+    "publisherFavicon": "A String", # Optional. A link to the company favicon of the publisher. The image dimensions should be favicon size: 16x16 pixels. The image format should be GIF, JPG or PNG.
+    "publisherName": "A String", # Optional. The name of the publisher of the product reviews. The information about the publisher, which may be a retailer, manufacturer, reviews service company, or any entity that publishes product reviews.
+    "rating": 3.14, # Optional. The reviewer's overall rating of the product.
+    "reviewCountry": "A String", # Optional. The country of the review defined by ISO 3166-1 Alpha-2 Country Code.
+    "reviewLanguage": "A String", # Optional. The language of the review defined by BCP-47 language code.
+    "reviewLink": { # The URI of the review landing page. # Optional. The URI of the review landing page.
+      "link": "A String", # Optional. The URI of the review landing page. For example: `http://www.example.com/review_5.html`.
+      "type": "A String", # Optional. Type of the review URI.
+    },
+    "reviewTime": "A String", # Required. The timestamp indicating when the review was written.
+    "reviewerId": "A String", # Optional. The author of the product review. A permanent, unique identifier for the author of the review in the publisher's system.
+    "reviewerImageLinks": [ # Optional. A URI to an image of the reviewed product created by the review author. The URI does not have to end with an image file extension.
+      "A String",
+    ],
+    "reviewerIsAnonymous": True or False, # Optional. Set to true if the reviewer should remain anonymous.
+    "reviewerUsername": "A String", # Optional. The name of the reviewer of the product review.
+    "skus": [ # Optional. Contains SKUs (stock keeping units) associated with a product. Often this matches the product Offer Id in the product feed.
+      "A String",
+    ],
+    "subclientName": "A String", # Optional. The name of the subclient of the product reviews. The subclient is an identifier of the product review source. It should be equivalent to the directory provided in the file data source path.
+    "title": "A String", # Optional. The title of the review.
+    "transactionId": "A String", # Optional. A permanent, unique identifier for the transaction associated with the review in the publisher's system. This ID can be used to indicate that multiple reviews are associated with the same transaction.
+  },
+  "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes.
+    { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
+      "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
+        # Object with schema name: CustomAttribute
+      ],
+      "name": "A String", # The name of the attribute.
+      "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
+    },
+  ],
+  "dataSource": "A String", # Output only. The primary data source of the product review.
+  "name": "A String", # Identifier. The name of the product review. Format: `"{productreview.name=accounts/{account}/productReviews/{productReview}}"`
+  "productReviewId": "A String", # Required. The permanent, unique identifier for the product review in the publisher’s system.
+  "productReviewStatus": { # Product review status. # Output only. The status of a product review, data validation issues, that is, information about a product review computed asynchronously.
+    "createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+    "destinationStatuses": [ # Output only. The intended destinations for the product review.
+      { # The destination status of the product review status.
+        "reportingContext": "A String", # Output only. The name of the reporting context.
+      },
+    ],
+    "itemLevelIssues": [ # Output only. A list of all issues associated with the product review.
+      { # The ItemLevelIssue of the product review status.
+        "attribute": "A String", # Output only. The attribute's name, if the issue is caused by a single attribute.
+        "code": "A String", # Output only. The error code of the issue.
+        "description": "A String", # Output only. A short issue description in English.
+        "detail": "A String", # Output only. A detailed issue description in English.
+        "documentation": "A String", # Output only. The URL of a web page to help with resolving this issue.
+        "reportingContext": "A String", # Output only. The reporting context the issue applies to.
+        "resolution": "A String", # Output only. Whether the issue can be resolved by the merchant.
+        "severity": "A String", # Output only. How this issue affects serving of the product review.
+      },
+    ],
+    "lastUpdateTime": "A String", # Output only. Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+  },
+}
+
+  dataSource: string, Required. Format: `accounts/{account}/dataSources/{datasource}`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A review for a product. For more information, see [Introduction to Product Review Feeds](https://developers.google.com/product-review-feeds)
+  "attributes": { # Attributes. # Optional. A list of product review attributes.
+    "aggregatorName": "A String", # Optional. The name of the aggregator of the product reviews. A publisher may use a reviews aggregator to manage reviews and provide the feeds. This element indicates the use of an aggregator and contains information about the aggregator.
+    "asins": [ # Optional. Contains ASINs (Amazon Standard Identification Numbers) associated with a product.
+      "A String",
+    ],
+    "brands": [ # Optional. Contains brand names associated with a product.
+      "A String",
+    ],
+    "collectionMethod": "A String", # Optional. The method used to collect the review.
+    "cons": [ # Optional. Contains the disadvantages based on the opinion of the reviewer. Omit boilerplate text like "con:" unless it was written by the reviewer.
+      "A String",
+    ],
+    "content": "A String", # Required. The content of the review.
+    "gtins": [ # Optional. Contains GTINs (global trade item numbers) associated with a product. Sub-types of GTINs (e.g. UPC, EAN, ISBN, JAN) are supported.
+      "A String",
+    ],
+    "isSpam": True or False, # Optional. Indicates whether the review is marked as spam in the publisher's system.
+    "maxRating": "A String", # Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min attribute.
+    "minRating": "A String", # Optional. Contains the ratings associated with the review. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.
+    "mpns": [ # Optional. Contains MPNs (manufacturer part numbers) associated with a product.
+      "A String",
+    ],
+    "productLinks": [ # Optional. The URI of the product. This URI can have the same value as the `review_link` element, if the review URI and the product URI are the same.
+      "A String",
+    ],
+    "productNames": [ # Optional. Descriptive name of a product.
+      "A String",
+    ],
+    "pros": [ # Optional. Contains the advantages based on the opinion of the reviewer. Omit boilerplate text like "pro:" unless it was written by the reviewer.
+      "A String",
+    ],
+    "publisherFavicon": "A String", # Optional. A link to the company favicon of the publisher. The image dimensions should be favicon size: 16x16 pixels. The image format should be GIF, JPG or PNG.
+    "publisherName": "A String", # Optional. The name of the publisher of the product reviews. The information about the publisher, which may be a retailer, manufacturer, reviews service company, or any entity that publishes product reviews.
+    "rating": 3.14, # Optional. The reviewer's overall rating of the product.
+    "reviewCountry": "A String", # Optional. The country of the review defined by ISO 3166-1 Alpha-2 Country Code.
+    "reviewLanguage": "A String", # Optional. The language of the review defined by BCP-47 language code.
+    "reviewLink": { # The URI of the review landing page. # Optional. The URI of the review landing page.
+      "link": "A String", # Optional. The URI of the review landing page. For example: `http://www.example.com/review_5.html`.
+      "type": "A String", # Optional. Type of the review URI.
+    },
+    "reviewTime": "A String", # Required. The timestamp indicating when the review was written.
+    "reviewerId": "A String", # Optional. The author of the product review. A permanent, unique identifier for the author of the review in the publisher's system.
+    "reviewerImageLinks": [ # Optional. A URI to an image of the reviewed product created by the review author. The URI does not have to end with an image file extension.
+      "A String",
+    ],
+    "reviewerIsAnonymous": True or False, # Optional. Set to true if the reviewer should remain anonymous.
+    "reviewerUsername": "A String", # Optional. The name of the reviewer of the product review.
+    "skus": [ # Optional. Contains SKUs (stock keeping units) associated with a product. Often this matches the product Offer Id in the product feed.
+      "A String",
+    ],
+    "subclientName": "A String", # Optional. The name of the subclient of the product reviews. The subclient is an identifier of the product review source. It should be equivalent to the directory provided in the file data source path.
+    "title": "A String", # Optional. The title of the review.
+    "transactionId": "A String", # Optional. A permanent, unique identifier for the transaction associated with the review in the publisher's system. This ID can be used to indicate that multiple reviews are associated with the same transaction.
+  },
+  "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes.
+    { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
+      "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
+        # Object with schema name: CustomAttribute
+      ],
+      "name": "A String", # The name of the attribute.
+      "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
+    },
+  ],
+  "dataSource": "A String", # Output only. The primary data source of the product review.
+  "name": "A String", # Identifier. The name of the product review. Format: `"{productreview.name=accounts/{account}/productReviews/{productReview}}"`
+  "productReviewId": "A String", # Required. The permanent, unique identifier for the product review in the publisher’s system.
+  "productReviewStatus": { # Product review status. # Output only. The status of a product review, data validation issues, that is, information about a product review computed asynchronously.
+    "createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+    "destinationStatuses": [ # Output only. The intended destinations for the product review.
+      { # The destination status of the product review status.
+        "reportingContext": "A String", # Output only. The name of the reporting context.
+      },
+    ],
+    "itemLevelIssues": [ # Output only. A list of all issues associated with the product review.
+      { # The ItemLevelIssue of the product review status.
+        "attribute": "A String", # Output only. The attribute's name, if the issue is caused by a single attribute.
+        "code": "A String", # Output only. The error code of the issue.
+        "description": "A String", # Output only. A short issue description in English.
+        "detail": "A String", # Output only. A detailed issue description in English.
+        "documentation": "A String", # Output only. The URL of a web page to help with resolving this issue.
+        "reportingContext": "A String", # Output only. The reporting context the issue applies to.
+        "resolution": "A String", # Output only. Whether the issue can be resolved by the merchant.
+        "severity": "A String", # Output only. How this issue affects serving of the product review.
+      },
+    ],
+    "lastUpdateTime": "A String", # Output only. Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists product reviews.
+
+Args:
+  parent: string, Required. The account to list product reviews for. Format: accounts/{account} (required)
+  pageSize: integer, Optional. The maximum number of products to return. The service may return fewer than this value.
+  pageToken: string, Optional. A page token, received from a previous `ListProductReviews` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProductReviews` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # response message for the ListProductReviews method.
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "productReviews": [ # The product review.
+    { # A review for a product. For more information, see [Introduction to Product Review Feeds](https://developers.google.com/product-review-feeds)
+      "attributes": { # Attributes. # Optional. A list of product review attributes.
+        "aggregatorName": "A String", # Optional. The name of the aggregator of the product reviews. A publisher may use a reviews aggregator to manage reviews and provide the feeds. This element indicates the use of an aggregator and contains information about the aggregator.
+        "asins": [ # Optional. Contains ASINs (Amazon Standard Identification Numbers) associated with a product.
+          "A String",
+        ],
+        "brands": [ # Optional. Contains brand names associated with a product.
+          "A String",
+        ],
+        "collectionMethod": "A String", # Optional. The method used to collect the review.
+        "cons": [ # Optional. Contains the disadvantages based on the opinion of the reviewer. Omit boilerplate text like "con:" unless it was written by the reviewer.
+          "A String",
+        ],
+        "content": "A String", # Required. The content of the review.
+        "gtins": [ # Optional. Contains GTINs (global trade item numbers) associated with a product. Sub-types of GTINs (e.g. UPC, EAN, ISBN, JAN) are supported.
+          "A String",
+        ],
+        "isSpam": True or False, # Optional. Indicates whether the review is marked as spam in the publisher's system.
+        "maxRating": "A String", # Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min attribute.
+        "minRating": "A String", # Optional. Contains the ratings associated with the review. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.
+        "mpns": [ # Optional. Contains MPNs (manufacturer part numbers) associated with a product.
+          "A String",
+        ],
+        "productLinks": [ # Optional. The URI of the product. This URI can have the same value as the `review_link` element, if the review URI and the product URI are the same.
+          "A String",
+        ],
+        "productNames": [ # Optional. Descriptive name of a product.
+          "A String",
+        ],
+        "pros": [ # Optional. Contains the advantages based on the opinion of the reviewer. Omit boilerplate text like "pro:" unless it was written by the reviewer.
+          "A String",
+        ],
+        "publisherFavicon": "A String", # Optional. A link to the company favicon of the publisher. The image dimensions should be favicon size: 16x16 pixels. The image format should be GIF, JPG or PNG.
+        "publisherName": "A String", # Optional. The name of the publisher of the product reviews. The information about the publisher, which may be a retailer, manufacturer, reviews service company, or any entity that publishes product reviews.
+        "rating": 3.14, # Optional. The reviewer's overall rating of the product.
+        "reviewCountry": "A String", # Optional. The country of the review defined by ISO 3166-1 Alpha-2 Country Code.
+        "reviewLanguage": "A String", # Optional. The language of the review defined by BCP-47 language code.
+        "reviewLink": { # The URI of the review landing page. # Optional. The URI of the review landing page.
+          "link": "A String", # Optional. The URI of the review landing page. For example: `http://www.example.com/review_5.html`.
+          "type": "A String", # Optional. Type of the review URI.
+        },
+        "reviewTime": "A String", # Required. The timestamp indicating when the review was written.
+        "reviewerId": "A String", # Optional. The author of the product review. A permanent, unique identifier for the author of the review in the publisher's system.
+        "reviewerImageLinks": [ # Optional. A URI to an image of the reviewed product created by the review author. The URI does not have to end with an image file extension.
+          "A String",
+        ],
+        "reviewerIsAnonymous": True or False, # Optional. Set to true if the reviewer should remain anonymous.
+        "reviewerUsername": "A String", # Optional. The name of the reviewer of the product review.
+        "skus": [ # Optional. Contains SKUs (stock keeping units) associated with a product. Often this matches the product Offer Id in the product feed.
+          "A String",
+        ],
+        "subclientName": "A String", # Optional. The name of the subclient of the product reviews. The subclient is an identifier of the product review source. It should be equivalent to the directory provided in the file data source path.
+        "title": "A String", # Optional. The title of the review.
+        "transactionId": "A String", # Optional. A permanent, unique identifier for the transaction associated with the review in the publisher's system. This ID can be used to indicate that multiple reviews are associated with the same transaction.
+      },
+      "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes.
+        { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
+          "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
+            # Object with schema name: CustomAttribute
+          ],
+          "name": "A String", # The name of the attribute.
+          "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
+        },
+      ],
+      "dataSource": "A String", # Output only. The primary data source of the product review.
+      "name": "A String", # Identifier. The name of the product review. Format: `"{productreview.name=accounts/{account}/productReviews/{productReview}}"`
+      "productReviewId": "A String", # Required. The permanent, unique identifier for the product review in the publisher’s system.
+      "productReviewStatus": { # Product review status. # Output only. The status of a product review, data validation issues, that is, information about a product review computed asynchronously.
+        "createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+        "destinationStatuses": [ # Output only. The intended destinations for the product review.
+          { # The destination status of the product review status.
+            "reportingContext": "A String", # Output only. The name of the reporting context.
+          },
+        ],
+        "itemLevelIssues": [ # Output only. A list of all issues associated with the product review.
+          { # The ItemLevelIssue of the product review status.
+            "attribute": "A String", # Output only. The attribute's name, if the issue is caused by a single attribute.
+            "code": "A String", # Output only. The error code of the issue.
+            "description": "A String", # Output only. A short issue description in English.
+            "detail": "A String", # Output only. A detailed issue description in English.
+            "documentation": "A String", # Output only. The URL of a web page to help with resolving this issue.
+            "reportingContext": "A String", # Output only. The reporting context the issue applies to.
+            "resolution": "A String", # Output only. Whether the issue can be resolved by the merchant.
+            "severity": "A String", # Output only. How this issue affects serving of the product review.
+          },
+        ],
+        "lastUpdateTime": "A String", # Output only. Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+      },
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/merchantapi_reviews_v1beta.html b/docs/dyn/merchantapi_reviews_v1beta.html new file mode 100644 index 0000000000..e655744b44 --- /dev/null +++ b/docs/dyn/merchantapi_reviews_v1beta.html @@ -0,0 +1,111 @@ + + + +

Merchant API

+

Instance Methods

+

+ accounts() +

+

Returns the accounts Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

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

Method Details

Args: name: string, Required. The channel for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] (required) - force: boolean, If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation. + force: boolean, If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, this operation will fail if the notification channel is referenced by existing alerting policies. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/netapp_v1.html b/docs/dyn/netapp_v1.html new file mode 100644 index 0000000000..8f43ab24a3 --- /dev/null +++ b/docs/dyn/netapp_v1.html @@ -0,0 +1,111 @@ + + + +

NetApp API

+

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

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

NetApp API . projects

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1.projects.locations.activeDirectories.html b/docs/dyn/netapp_v1.projects.locations.activeDirectories.html new file mode 100644 index 0000000000..090de7e67a --- /dev/null +++ b/docs/dyn/netapp_v1.projects.locations.activeDirectories.html @@ -0,0 +1,405 @@ + + + +

NetApp API . projects . locations . activeDirectories

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

CreateActiveDirectory Creates the active directory specified in the request.

+

+ delete(name, x__xgafv=None)

+

Delete the active directory specified in the request.

+

+ get(name, x__xgafv=None)

+

Describes a specified active directory.

+

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

+

Lists active directories.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update the parameters of an active directories.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, activeDirectoryId=None, body=None, x__xgafv=None) +
CreateActiveDirectory Creates the active directory specified in the request.
+
+Args:
+  parent: string, Required. Value for parent. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # ActiveDirectory is the public representation of the active directory config.
+  "administrators": [ # Optional. Users to be added to the Built-in Admininstrators group.
+    "A String",
+  ],
+  "aesEncryption": True or False, # If enabled, AES encryption will be enabled for SMB communication.
+  "backupOperators": [ # Optional. Users to be added to the Built-in Backup Operator active directory group.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Create time of the active directory.
+  "description": "A String", # Description of the active directory.
+  "dns": "A String", # Required. Comma separated list of DNS server IP addresses for the Active Directory domain.
+  "domain": "A String", # Required. Name of the Active Directory domain
+  "encryptDcConnections": True or False, # If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.
+  "kdcHostname": "A String", # Name of the active directory machine. This optional parameter is used only while creating kerberos volume
+  "kdcIp": "A String", # KDC server IP address for the active directory machine.
+  "labels": { # Labels for the active directory.
+    "a_key": "A String",
+  },
+  "ldapSigning": True or False, # Specifies whether or not the LDAP traffic needs to be signed.
+  "name": "A String", # Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.
+  "netBiosPrefix": "A String", # Required. NetBIOSPrefix is used as a prefix for SMB server name.
+  "nfsUsersWithLdap": True or False, # If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.
+  "organizationalUnit": "A String", # The Organizational Unit (OU) within the Windows Active Directory the user belongs to.
+  "password": "A String", # Required. Password of the Active Directory domain administrator.
+  "securityOperators": [ # Optional. Domain users to be given the SeSecurityPrivilege.
+    "A String",
+  ],
+  "site": "A String", # The Active Directory site the service will limit Domain Controller discovery too.
+  "state": "A String", # Output only. The state of the AD.
+  "stateDetails": "A String", # Output only. The state details of the Active Directory.
+  "username": "A String", # Required. Username of the Active Directory domain administrator.
+}
+
+  activeDirectoryId: string, Required. ID of the active directory to create. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter , the last a letter or a number, and a 63 character maximum.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Delete the active directory specified in the request.
+
+Args:
+  name: string, Required. Name of the active directory. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Describes a specified active directory.
+
+Args:
+  name: string, Required. Name of the active directory. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ActiveDirectory is the public representation of the active directory config.
+  "administrators": [ # Optional. Users to be added to the Built-in Admininstrators group.
+    "A String",
+  ],
+  "aesEncryption": True or False, # If enabled, AES encryption will be enabled for SMB communication.
+  "backupOperators": [ # Optional. Users to be added to the Built-in Backup Operator active directory group.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Create time of the active directory.
+  "description": "A String", # Description of the active directory.
+  "dns": "A String", # Required. Comma separated list of DNS server IP addresses for the Active Directory domain.
+  "domain": "A String", # Required. Name of the Active Directory domain
+  "encryptDcConnections": True or False, # If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.
+  "kdcHostname": "A String", # Name of the active directory machine. This optional parameter is used only while creating kerberos volume
+  "kdcIp": "A String", # KDC server IP address for the active directory machine.
+  "labels": { # Labels for the active directory.
+    "a_key": "A String",
+  },
+  "ldapSigning": True or False, # Specifies whether or not the LDAP traffic needs to be signed.
+  "name": "A String", # Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.
+  "netBiosPrefix": "A String", # Required. NetBIOSPrefix is used as a prefix for SMB server name.
+  "nfsUsersWithLdap": True or False, # If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.
+  "organizationalUnit": "A String", # The Organizational Unit (OU) within the Windows Active Directory the user belongs to.
+  "password": "A String", # Required. Password of the Active Directory domain administrator.
+  "securityOperators": [ # Optional. Domain users to be given the SeSecurityPrivilege.
+    "A String",
+  ],
+  "site": "A String", # The Active Directory site the service will limit Domain Controller discovery too.
+  "state": "A String", # Output only. The state of the AD.
+  "stateDetails": "A String", # Output only. The state details of the Active Directory.
+  "username": "A String", # Required. Username of the Active Directory domain administrator.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists active directories.
+
+Args:
+  parent: string, Required. Parent value for ListActiveDirectoriesRequest (required)
+  filter: string, Filtering results
+  orderBy: string, Hint for how to order the results
+  pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+  pageToken: string, A token identifying a page of results the server should return.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ListActiveDirectoriesResponse contains all the active directories requested.
+  "activeDirectories": [ # The list of active directories.
+    { # ActiveDirectory is the public representation of the active directory config.
+      "administrators": [ # Optional. Users to be added to the Built-in Admininstrators group.
+        "A String",
+      ],
+      "aesEncryption": True or False, # If enabled, AES encryption will be enabled for SMB communication.
+      "backupOperators": [ # Optional. Users to be added to the Built-in Backup Operator active directory group.
+        "A String",
+      ],
+      "createTime": "A String", # Output only. Create time of the active directory.
+      "description": "A String", # Description of the active directory.
+      "dns": "A String", # Required. Comma separated list of DNS server IP addresses for the Active Directory domain.
+      "domain": "A String", # Required. Name of the Active Directory domain
+      "encryptDcConnections": True or False, # If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.
+      "kdcHostname": "A String", # Name of the active directory machine. This optional parameter is used only while creating kerberos volume
+      "kdcIp": "A String", # KDC server IP address for the active directory machine.
+      "labels": { # Labels for the active directory.
+        "a_key": "A String",
+      },
+      "ldapSigning": True or False, # Specifies whether or not the LDAP traffic needs to be signed.
+      "name": "A String", # Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.
+      "netBiosPrefix": "A String", # Required. NetBIOSPrefix is used as a prefix for SMB server name.
+      "nfsUsersWithLdap": True or False, # If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.
+      "organizationalUnit": "A String", # The Organizational Unit (OU) within the Windows Active Directory the user belongs to.
+      "password": "A String", # Required. Password of the Active Directory domain administrator.
+      "securityOperators": [ # Optional. Domain users to be given the SeSecurityPrivilege.
+        "A String",
+      ],
+      "site": "A String", # The Active Directory site the service will limit Domain Controller discovery too.
+      "state": "A String", # Output only. The state of the AD.
+      "stateDetails": "A String", # Output only. The state details of the Active Directory.
+      "username": "A String", # Required. Username of the Active Directory domain administrator.
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Update the parameters of an active directories.
+
+Args:
+  name: string, Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # ActiveDirectory is the public representation of the active directory config.
+  "administrators": [ # Optional. Users to be added to the Built-in Admininstrators group.
+    "A String",
+  ],
+  "aesEncryption": True or False, # If enabled, AES encryption will be enabled for SMB communication.
+  "backupOperators": [ # Optional. Users to be added to the Built-in Backup Operator active directory group.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Create time of the active directory.
+  "description": "A String", # Description of the active directory.
+  "dns": "A String", # Required. Comma separated list of DNS server IP addresses for the Active Directory domain.
+  "domain": "A String", # Required. Name of the Active Directory domain
+  "encryptDcConnections": True or False, # If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.
+  "kdcHostname": "A String", # Name of the active directory machine. This optional parameter is used only while creating kerberos volume
+  "kdcIp": "A String", # KDC server IP address for the active directory machine.
+  "labels": { # Labels for the active directory.
+    "a_key": "A String",
+  },
+  "ldapSigning": True or False, # Specifies whether or not the LDAP traffic needs to be signed.
+  "name": "A String", # Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.
+  "netBiosPrefix": "A String", # Required. NetBIOSPrefix is used as a prefix for SMB server name.
+  "nfsUsersWithLdap": True or False, # If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.
+  "organizationalUnit": "A String", # The Organizational Unit (OU) within the Windows Active Directory the user belongs to.
+  "password": "A String", # Required. Password of the Active Directory domain administrator.
+  "securityOperators": [ # Optional. Domain users to be given the SeSecurityPrivilege.
+    "A String",
+  ],
+  "site": "A String", # The Active Directory site the service will limit Domain Controller discovery too.
+  "state": "A String", # Output only. The state of the AD.
+  "stateDetails": "A String", # Output only. The state details of the Active Directory.
+  "username": "A String", # Required. Username of the Active Directory domain administrator.
+}
+
+  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Active Directory resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1.projects.locations.backupPolicies.html b/docs/dyn/netapp_v1.projects.locations.backupPolicies.html new file mode 100644 index 0000000000..af481a6795 --- /dev/null +++ b/docs/dyn/netapp_v1.projects.locations.backupPolicies.html @@ -0,0 +1,333 @@ + + + +

NetApp API . projects . locations . backupPolicies

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates new backup policy

+

+ delete(name, x__xgafv=None)

+

Warning! This operation will permanently delete the backup policy.

+

+ get(name, x__xgafv=None)

+

Returns the description of the specified backup policy by backup_policy_id.

+

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

+

Returns list of all available backup policies.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates settings of a specific backup policy.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, backupPolicyId=None, body=None, x__xgafv=None) +
Creates new backup policy
+
+Args:
+  parent: string, Required. The location to create the backup policies of, in the format `projects/{project_id}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Backup Policy.
+  "assignedVolumeCount": 42, # Output only. The total number of volumes assigned by this backup policy.
+  "createTime": "A String", # Output only. The time when the backup policy was created.
+  "dailyBackupLimit": 42, # Number of daily backups to keep. Note that the minimum daily backup limit is 2.
+  "description": "A String", # Description of the backup policy.
+  "enabled": True or False, # If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "monthlyBackupLimit": 42, # Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
+  "name": "A String", # Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.
+  "state": "A String", # Output only. The backup policy state.
+  "weeklyBackupLimit": 42, # Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
+}
+
+  backupPolicyId: string, Required. The ID to use for the backup policy. The ID must be unique within the specified location. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Warning! This operation will permanently delete the backup policy.
+
+Args:
+  name: string, Required. The backup policy resource name, in the format `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Returns the description of the specified backup policy by backup_policy_id.
+
+Args:
+  name: string, Required. The backupPolicy resource name, in the format `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Backup Policy.
+  "assignedVolumeCount": 42, # Output only. The total number of volumes assigned by this backup policy.
+  "createTime": "A String", # Output only. The time when the backup policy was created.
+  "dailyBackupLimit": 42, # Number of daily backups to keep. Note that the minimum daily backup limit is 2.
+  "description": "A String", # Description of the backup policy.
+  "enabled": True or False, # If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "monthlyBackupLimit": 42, # Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
+  "name": "A String", # Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.
+  "state": "A String", # Output only. The backup policy state.
+  "weeklyBackupLimit": 42, # Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns list of all available backup policies.
+
+Args:
+  parent: string, Required. Parent value for ListBackupPoliciesRequest (required)
+  filter: string, Filtering results
+  orderBy: string, Hint for how to order the results
+  pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+  pageToken: string, A token identifying a page of results the server should return.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ListBackupPoliciesResponse contains all the backup policies requested.
+  "backupPolicies": [ # The list of backup policies.
+    { # Backup Policy.
+      "assignedVolumeCount": 42, # Output only. The total number of volumes assigned by this backup policy.
+      "createTime": "A String", # Output only. The time when the backup policy was created.
+      "dailyBackupLimit": 42, # Number of daily backups to keep. Note that the minimum daily backup limit is 2.
+      "description": "A String", # Description of the backup policy.
+      "enabled": True or False, # If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.
+      "labels": { # Resource labels to represent user provided metadata.
+        "a_key": "A String",
+      },
+      "monthlyBackupLimit": 42, # Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
+      "name": "A String", # Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.
+      "state": "A String", # Output only. The backup policy state.
+      "weeklyBackupLimit": 42, # Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates settings of a specific backup policy.
+
+Args:
+  name: string, Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Backup Policy.
+  "assignedVolumeCount": 42, # Output only. The total number of volumes assigned by this backup policy.
+  "createTime": "A String", # Output only. The time when the backup policy was created.
+  "dailyBackupLimit": 42, # Number of daily backups to keep. Note that the minimum daily backup limit is 2.
+  "description": "A String", # Description of the backup policy.
+  "enabled": True or False, # If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "monthlyBackupLimit": 42, # Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
+  "name": "A String", # Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.
+  "state": "A String", # Output only. The backup policy state.
+  "weeklyBackupLimit": 42, # Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
+}
+
+  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Backup Policy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1.projects.locations.backupVaults.backups.html b/docs/dyn/netapp_v1.projects.locations.backupVaults.backups.html new file mode 100644 index 0000000000..51ebc1a1a4 --- /dev/null +++ b/docs/dyn/netapp_v1.projects.locations.backupVaults.backups.html @@ -0,0 +1,333 @@ + + + +

NetApp API . projects . locations . backupVaults . backups

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a backup from the volume specified in the request The backup can be created from the given snapshot if specified in the request. If no snapshot specified, there'll be a new snapshot taken to initiate the backup creation.

+

+ delete(name, x__xgafv=None)

+

Warning! This operation will permanently delete the backup.

+

+ get(name, x__xgafv=None)

+

Returns the description of the specified backup

+

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

+

Returns descriptions of all backups for a backupVault.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update backup with full spec.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, backupId=None, body=None, x__xgafv=None) +
Creates a backup from the volume specified in the request The backup can be created from the given snapshot if specified in the request. If no snapshot specified, there'll be a new snapshot taken to initiate the backup creation.
+
+Args:
+  parent: string, Required. The NetApp backupVault to create the backups of, in the format `projects/*/locations/*/backupVaults/{backup_vault_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A NetApp Backup.
+  "backupType": "A String", # Output only. Type of backup, manually created or created by a backup policy.
+  "chainStorageBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
+  "createTime": "A String", # Output only. The time when the backup was created.
+  "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.
+  "sourceSnapshot": "A String", # If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`
+  "sourceVolume": "A String", # Volume full name of this backup belongs to. Format: `projects/{projects_id}/locations/{location}/volumes/{volume_id}`
+  "state": "A String", # Output only. The backup state.
+  "volumeUsageBytes": "A String", # Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
+}
+
+  backupId: string, Required. The ID to use for the backup. The ID must be unique within the specified backupVault. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Warning! This operation will permanently delete the backup.
+
+Args:
+  name: string, Required. The backup resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Returns the description of the specified backup
+
+Args:
+  name: string, Required. The backup resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A NetApp Backup.
+  "backupType": "A String", # Output only. Type of backup, manually created or created by a backup policy.
+  "chainStorageBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
+  "createTime": "A String", # Output only. The time when the backup was created.
+  "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.
+  "sourceSnapshot": "A String", # If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`
+  "sourceVolume": "A String", # Volume full name of this backup belongs to. Format: `projects/{projects_id}/locations/{location}/volumes/{volume_id}`
+  "state": "A String", # Output only. The backup state.
+  "volumeUsageBytes": "A String", # Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns descriptions of all backups for a backupVault.
+
+Args:
+  parent: string, Required. The backupVault for which to retrieve backup information, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`. To retrieve backup information for all locations, use "-" for the `{location}` value. To retrieve backup information for all backupVaults, use "-" for the `{backup_vault_id}` value. To retrieve backup information for a volume, use "-" for the `{backup_vault_id}` value and specify volume full name with the filter. (required)
+  filter: string, The standard list filter. If specified, backups will be returned based on the attribute name that matches the filter expression. If empty, then no backups are filtered out. See https://google.aip.dev/160
+  orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
+  pageSize: integer, The maximum number of items to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ListBackupsResponse is the result of ListBackupsRequest.
+  "backups": [ # A list of backups in the project.
+    { # A NetApp Backup.
+      "backupType": "A String", # Output only. Type of backup, manually created or created by a backup policy.
+      "chainStorageBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
+      "createTime": "A String", # Output only. The time when the backup was created.
+      "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
+      "labels": { # Resource labels to represent user provided metadata.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.
+      "sourceSnapshot": "A String", # If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`
+      "sourceVolume": "A String", # Volume full name of this backup belongs to. Format: `projects/{projects_id}/locations/{location}/volumes/{volume_id}`
+      "state": "A String", # Output only. The backup state.
+      "volumeUsageBytes": "A String", # Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
+    },
+  ],
+  "nextPageToken": "A String", # The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Update backup with full spec.
+
+Args:
+  name: string, Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A NetApp Backup.
+  "backupType": "A String", # Output only. Type of backup, manually created or created by a backup policy.
+  "chainStorageBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
+  "createTime": "A String", # Output only. The time when the backup was created.
+  "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.
+  "sourceSnapshot": "A String", # If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`
+  "sourceVolume": "A String", # Volume full name of this backup belongs to. Format: `projects/{projects_id}/locations/{location}/volumes/{volume_id}`
+  "state": "A String", # Output only. The backup state.
+  "volumeUsageBytes": "A String", # Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
+}
+
+  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Backup resource to be updated. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1.projects.locations.backupVaults.html b/docs/dyn/netapp_v1.projects.locations.backupVaults.html new file mode 100644 index 0000000000..c02682b868 --- /dev/null +++ b/docs/dyn/netapp_v1.projects.locations.backupVaults.html @@ -0,0 +1,318 @@ + + + +

NetApp API . projects . locations . backupVaults

+

Instance Methods

+

+ backups() +

+

Returns the backups Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates new backup vault

+

+ delete(name, x__xgafv=None)

+

Warning! This operation will permanently delete the backup vault.

+

+ get(name, x__xgafv=None)

+

Returns the description of the specified backup vault

+

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

+

Returns list of all available backup vaults.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the settings of a specific backup vault.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, backupVaultId=None, body=None, x__xgafv=None) +
Creates new backup vault
+
+Args:
+  parent: string, Required. The location to create the backup vaults, in the format `projects/{project_id}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A NetApp BackupVault.
+  "createTime": "A String", # Output only. Create time of the backup vault.
+  "description": "A String", # Description of the backup vault.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.
+  "state": "A String", # Output only. The backup vault state.
+}
+
+  backupVaultId: string, Required. The ID to use for the backupVault. The ID must be unique within the specified location. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Warning! This operation will permanently delete the backup vault.
+
+Args:
+  name: string, Required. The backupVault resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Returns the description of the specified backup vault
+
+Args:
+  name: string, Required. The backupVault resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A NetApp BackupVault.
+  "createTime": "A String", # Output only. Create time of the backup vault.
+  "description": "A String", # Description of the backup vault.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.
+  "state": "A String", # Output only. The backup vault state.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns list of all available backup vaults.
+
+Args:
+  parent: string, Required. The location for which to retrieve backupVault information, in the format `projects/{project_id}/locations/{location}`. (required)
+  filter: string, List filter.
+  orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
+  pageSize: integer, The maximum number of items to return.
+  pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ListBackupVaultsResponse is the result of ListBackupVaultsRequest.
+  "backupVaults": [ # A list of backupVaults in the project for the specified location.
+    { # A NetApp BackupVault.
+      "createTime": "A String", # Output only. Create time of the backup vault.
+      "description": "A String", # Description of the backup vault.
+      "labels": { # Resource labels to represent user provided metadata.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.
+      "state": "A String", # Output only. The backup vault state.
+    },
+  ],
+  "nextPageToken": "A String", # The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the settings of a specific backup vault.
+
+Args:
+  name: string, Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A NetApp BackupVault.
+  "createTime": "A String", # Output only. Create time of the backup vault.
+  "description": "A String", # Description of the backup vault.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.
+  "state": "A String", # Output only. The backup vault state.
+}
+
+  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Backup resource to be updated. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1.projects.locations.html b/docs/dyn/netapp_v1.projects.locations.html new file mode 100644 index 0000000000..0789ebc730 --- /dev/null +++ b/docs/dyn/netapp_v1.projects.locations.html @@ -0,0 +1,206 @@ + + + +

NetApp API . projects . locations

+

Instance Methods

+

+ activeDirectories() +

+

Returns the activeDirectories Resource.

+ +

+ backupPolicies() +

+

Returns the backupPolicies Resource.

+ +

+ backupVaults() +

+

Returns the backupVaults Resource.

+ +

+ kmsConfigs() +

+

Returns the kmsConfigs Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ storagePools() +

+

Returns the storagePools Resource.

+ +

+ volumes() +

+

Returns the volumes Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets information about a location.

+

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

+

Lists information about the supported locations for this service.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

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

NetApp API . projects . locations . kmsConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new KMS config.

+

+ delete(name, x__xgafv=None)

+

Warning! This operation will permanently delete the Kms config.

+

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

+

Encrypt the existing volumes without CMEK encryption with the desired the KMS config for the whole region.

+

+ get(name, x__xgafv=None)

+

Returns the description of the specified KMS config by kms_config_id.

+

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

+

Returns descriptions of all KMS configs owned by the caller.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the Kms config properties with the full spec

+

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

+

Verifies KMS config reachability.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, kmsConfigId=None, x__xgafv=None) +
Creates a new KMS config.
+
+Args:
+  parent: string, Required. Value for parent. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # KmsConfig is the customer managed encryption key(CMEK) configuration.
+  "createTime": "A String", # Output only. Create time of the KmsConfig.
+  "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.
+  "description": "A String", # Description of the KmsConfig.
+  "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key.
+  "labels": { # Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the KmsConfig.
+  "serviceAccount": "A String", # Output only. The Service account which will have access to the customer provided encryption key.
+  "state": "A String", # Output only. State of the KmsConfig.
+  "stateDetails": "A String", # Output only. State details of the KmsConfig.
+}
+
+  kmsConfigId: string, Required. Id of the requesting KmsConfig. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Warning! This operation will permanently delete the Kms config.
+
+Args:
+  name: string, Required. Name of the KmsConfig. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ encrypt(name, body=None, x__xgafv=None) +
Encrypt the existing volumes without CMEK encryption with the desired the KMS config for the whole region.
+
+Args:
+  name: string, Required. Name of the KmsConfig. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # EncryptVolumesRequest specifies the KMS config to encrypt existing volumes.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Returns the description of the specified KMS config by kms_config_id.
+
+Args:
+  name: string, Required. Name of the KmsConfig (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # KmsConfig is the customer managed encryption key(CMEK) configuration.
+  "createTime": "A String", # Output only. Create time of the KmsConfig.
+  "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.
+  "description": "A String", # Description of the KmsConfig.
+  "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key.
+  "labels": { # Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the KmsConfig.
+  "serviceAccount": "A String", # Output only. The Service account which will have access to the customer provided encryption key.
+  "state": "A String", # Output only. State of the KmsConfig.
+  "stateDetails": "A String", # Output only. State details of the KmsConfig.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns descriptions of all KMS configs owned by the caller.
+
+Args:
+  parent: string, Required. Parent value (required)
+  filter: string, List filter.
+  orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
+  pageSize: integer, The maximum number of items to return.
+  pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ListKmsConfigsResponse is the response to a ListKmsConfigsRequest.
+  "kmsConfigs": [ # The list of KmsConfigs
+    { # KmsConfig is the customer managed encryption key(CMEK) configuration.
+      "createTime": "A String", # Output only. Create time of the KmsConfig.
+      "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.
+      "description": "A String", # Description of the KmsConfig.
+      "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key.
+      "labels": { # Labels as key value pairs
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. Name of the KmsConfig.
+      "serviceAccount": "A String", # Output only. The Service account which will have access to the customer provided encryption key.
+      "state": "A String", # Output only. State of the KmsConfig.
+      "stateDetails": "A String", # Output only. State details of the KmsConfig.
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the Kms config properties with the full spec
+
+Args:
+  name: string, Identifier. Name of the KmsConfig. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # KmsConfig is the customer managed encryption key(CMEK) configuration.
+  "createTime": "A String", # Output only. Create time of the KmsConfig.
+  "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.
+  "description": "A String", # Description of the KmsConfig.
+  "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key.
+  "labels": { # Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the KmsConfig.
+  "serviceAccount": "A String", # Output only. The Service account which will have access to the customer provided encryption key.
+  "state": "A String", # Output only. State of the KmsConfig.
+  "stateDetails": "A String", # Output only. State details of the KmsConfig.
+}
+
+  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the KmsConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ verify(name, body=None, x__xgafv=None) +
Verifies KMS config reachability.
+
+Args:
+  name: string, Required. Name of the KMS Config to be verified. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # VerifyKmsConfigRequest specifies the KMS config to be validated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # VerifyKmsConfigResponse contains the information if the config is correctly and error message.
+  "healthError": "A String", # Output only. Error message if config is not healthy.
+  "healthy": True or False, # Output only. If the customer key configured correctly to the encrypt volume.
+  "instructions": "A String", # Output only. Instructions for the customers to provide the access to the encryption key.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1.projects.locations.operations.html b/docs/dyn/netapp_v1.projects.locations.operations.html new file mode 100644 index 0000000000..651d7fa3a2 --- /dev/null +++ b/docs/dyn/netapp_v1.projects.locations.operations.html @@ -0,0 +1,235 @@ + + + +

NetApp API . projects . locations . operations

+

Instance Methods

+

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

+

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

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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

+

+ get(name, x__xgafv=None)

+

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

+

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

+

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

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ cancel(name, body=None, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1.projects.locations.storagePools.html b/docs/dyn/netapp_v1.projects.locations.storagePools.html new file mode 100644 index 0000000000..76f9eabd2a --- /dev/null +++ b/docs/dyn/netapp_v1.projects.locations.storagePools.html @@ -0,0 +1,417 @@ + + + +

NetApp API . projects . locations . storagePools

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new storage pool.

+

+ delete(name, x__xgafv=None)

+

Warning! This operation will permanently delete the storage pool.

+

+ get(name, x__xgafv=None)

+

Returns the description of the specified storage pool by poolId.

+

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

+

Returns descriptions of all storage pools owned by the caller.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the storage pool properties with the full spec

+

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

+

This operation will switch the active/replica zone for a regional storagePool.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, storagePoolId=None, x__xgafv=None) +
Creates a new storage pool.
+
+Args:
+  parent: string, Required. Value for parent. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # StoragePool is a container for volumes with a service level and capacity. Volumes can be created in a pool of sufficient available capacity. StoragePool capacity is what you are billed for.
+  "activeDirectory": "A String", # Optional. Specifies the Active Directory to be used for creating a SMB volume.
+  "allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.
+  "capacityGib": "A String", # Required. Capacity in GIB of the pool
+  "createTime": "A String", # Output only. Create time of the storage pool
+  "description": "A String", # Optional. Description of the storage pool
+  "encryptionType": "A String", # Output only. Specifies the current pool encryption key source.
+  "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
+  "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "ldapEnabled": True or False, # Optional. Flag indicating if the pool is NFS LDAP enabled or not.
+  "name": "A String", # Identifier. Name of the storage pool
+  "network": "A String", # Required. VPC Network name. Format: projects/{project}/global/networks/{network}
+  "psaRange": "A String", # Optional. This field is not implemented. The values provided in this field are ignored.
+  "replicaZone": "A String", # Optional. Specifies the replica zone for regional storagePool.
+  "serviceLevel": "A String", # Required. Service level of the storage pool
+  "state": "A String", # Output only. State of the storage pool
+  "stateDetails": "A String", # Output only. State details of the storage pool
+  "volumeCapacityGib": "A String", # Output only. Allocated size of all volumes in GIB in the storage pool
+  "volumeCount": 42, # Output only. Volume count of the storage pool
+  "zone": "A String", # Optional. Specifies the active zone for regional storagePool.
+}
+
+  storagePoolId: string, Required. Id of the requesting storage pool. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Warning! This operation will permanently delete the storage pool.
+
+Args:
+  name: string, Required. Name of the storage pool (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Returns the description of the specified storage pool by poolId.
+
+Args:
+  name: string, Required. Name of the storage pool (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # StoragePool is a container for volumes with a service level and capacity. Volumes can be created in a pool of sufficient available capacity. StoragePool capacity is what you are billed for.
+  "activeDirectory": "A String", # Optional. Specifies the Active Directory to be used for creating a SMB volume.
+  "allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.
+  "capacityGib": "A String", # Required. Capacity in GIB of the pool
+  "createTime": "A String", # Output only. Create time of the storage pool
+  "description": "A String", # Optional. Description of the storage pool
+  "encryptionType": "A String", # Output only. Specifies the current pool encryption key source.
+  "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
+  "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "ldapEnabled": True or False, # Optional. Flag indicating if the pool is NFS LDAP enabled or not.
+  "name": "A String", # Identifier. Name of the storage pool
+  "network": "A String", # Required. VPC Network name. Format: projects/{project}/global/networks/{network}
+  "psaRange": "A String", # Optional. This field is not implemented. The values provided in this field are ignored.
+  "replicaZone": "A String", # Optional. Specifies the replica zone for regional storagePool.
+  "serviceLevel": "A String", # Required. Service level of the storage pool
+  "state": "A String", # Output only. State of the storage pool
+  "stateDetails": "A String", # Output only. State details of the storage pool
+  "volumeCapacityGib": "A String", # Output only. Allocated size of all volumes in GIB in the storage pool
+  "volumeCount": 42, # Output only. Volume count of the storage pool
+  "zone": "A String", # Optional. Specifies the active zone for regional storagePool.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns descriptions of all storage pools owned by the caller.
+
+Args:
+  parent: string, Required. Parent value (required)
+  filter: string, Optional. List filter.
+  orderBy: string, Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).
+  pageSize: integer, Optional. The maximum number of items to return.
+  pageToken: string, Optional. The next_page_token value to use if there are additional results to retrieve for this list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ListStoragePoolsResponse is the response to a ListStoragePoolsRequest.
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "storagePools": [ # The list of StoragePools
+    { # StoragePool is a container for volumes with a service level and capacity. Volumes can be created in a pool of sufficient available capacity. StoragePool capacity is what you are billed for.
+      "activeDirectory": "A String", # Optional. Specifies the Active Directory to be used for creating a SMB volume.
+      "allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.
+      "capacityGib": "A String", # Required. Capacity in GIB of the pool
+      "createTime": "A String", # Output only. Create time of the storage pool
+      "description": "A String", # Optional. Description of the storage pool
+      "encryptionType": "A String", # Output only. Specifies the current pool encryption key source.
+      "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
+      "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption.
+      "labels": { # Optional. Labels as key value pairs
+        "a_key": "A String",
+      },
+      "ldapEnabled": True or False, # Optional. Flag indicating if the pool is NFS LDAP enabled or not.
+      "name": "A String", # Identifier. Name of the storage pool
+      "network": "A String", # Required. VPC Network name. Format: projects/{project}/global/networks/{network}
+      "psaRange": "A String", # Optional. This field is not implemented. The values provided in this field are ignored.
+      "replicaZone": "A String", # Optional. Specifies the replica zone for regional storagePool.
+      "serviceLevel": "A String", # Required. Service level of the storage pool
+      "state": "A String", # Output only. State of the storage pool
+      "stateDetails": "A String", # Output only. State details of the storage pool
+      "volumeCapacityGib": "A String", # Output only. Allocated size of all volumes in GIB in the storage pool
+      "volumeCount": 42, # Output only. Volume count of the storage pool
+      "zone": "A String", # Optional. Specifies the active zone for regional storagePool.
+    },
+  ],
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the storage pool properties with the full spec
+
+Args:
+  name: string, Identifier. Name of the storage pool (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # StoragePool is a container for volumes with a service level and capacity. Volumes can be created in a pool of sufficient available capacity. StoragePool capacity is what you are billed for.
+  "activeDirectory": "A String", # Optional. Specifies the Active Directory to be used for creating a SMB volume.
+  "allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.
+  "capacityGib": "A String", # Required. Capacity in GIB of the pool
+  "createTime": "A String", # Output only. Create time of the storage pool
+  "description": "A String", # Optional. Description of the storage pool
+  "encryptionType": "A String", # Output only. Specifies the current pool encryption key source.
+  "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
+  "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "ldapEnabled": True or False, # Optional. Flag indicating if the pool is NFS LDAP enabled or not.
+  "name": "A String", # Identifier. Name of the storage pool
+  "network": "A String", # Required. VPC Network name. Format: projects/{project}/global/networks/{network}
+  "psaRange": "A String", # Optional. This field is not implemented. The values provided in this field are ignored.
+  "replicaZone": "A String", # Optional. Specifies the replica zone for regional storagePool.
+  "serviceLevel": "A String", # Required. Service level of the storage pool
+  "state": "A String", # Output only. State of the storage pool
+  "stateDetails": "A String", # Output only. State details of the storage pool
+  "volumeCapacityGib": "A String", # Output only. Allocated size of all volumes in GIB in the storage pool
+  "volumeCount": 42, # Output only. Volume count of the storage pool
+  "zone": "A String", # Optional. Specifies the active zone for regional storagePool.
+}
+
+  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the StoragePool resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ switch(name, body=None, x__xgafv=None) +
This operation will switch the active/replica zone for a regional storagePool.
+
+Args:
+  name: string, Required. Name of the storage pool (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # SwitchActiveReplicaZoneRequest switch the active/replica zone for a regional storagePool.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1.projects.locations.volumes.html b/docs/dyn/netapp_v1.projects.locations.volumes.html new file mode 100644 index 0000000000..83cb5b953e --- /dev/null +++ b/docs/dyn/netapp_v1.projects.locations.volumes.html @@ -0,0 +1,757 @@ + + + +

NetApp API . projects . locations . volumes

+

Instance Methods

+

+ replications() +

+

Returns the replications Resource.

+ +

+ snapshots() +

+

Returns the snapshots Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new Volume in a given project and location.

+

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

+

Deletes a single Volume.

+

+ get(name, x__xgafv=None)

+

Gets details of a single Volume.

+

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

+

Lists Volumes in a given project.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the parameters of a single Volume.

+

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

+

Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, volumeId=None, x__xgafv=None) +
Creates a new Volume in a given project and location.
+
+Args:
+  parent: string, Required. Value for parent. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Volume provides a filesystem that you can mount.
+  "activeDirectory": "A String", # Output only. Specifies the ActiveDirectory name of a SMB volume.
+  "backupConfig": { # BackupConfig contains backup related config on a volume. # BackupConfig of the volume.
+    "backupChainBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).
+    "backupPolicies": [ # Optional. When specified, schedule backups will be created based on the policy configuration.
+      "A String",
+    ],
+    "backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
+    "scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
+  },
+  "capacityGib": "A String", # Required. Capacity in GIB of the volume
+  "coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data in GiB.
+  "createTime": "A String", # Output only. Create time of the volume
+  "description": "A String", # Optional. Description of the volume
+  "encryptionType": "A String", # Output only. Specified the current volume encryption key source.
+  "exportPolicy": { # Defines the export policy for the volume. # Optional. Export policy of the volume
+    "rules": [ # Required. List of export policy rules
+      { # An export policy rule describing various export options.
+        "accessType": "A String", # Access type (ReadWrite, ReadOnly, None)
+        "allowedClients": "A String", # Comma separated list of allowed clients IP addresses
+        "hasRootAccess": "A String", # Whether Unix root access will be granted.
+        "kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
+        "kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled.
+        "kerberos5iReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
+        "kerberos5iReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value be ignored if this is enabled.
+        "kerberos5pReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
+        "kerberos5pReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value be ignored if this is enabled.
+        "nfsv3": True or False, # NFS V3 protocol.
+        "nfsv4": True or False, # NFS V4 protocol.
+      },
+    ],
+  },
+  "hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship.
+  "kerberosEnabled": True or False, # Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
+  "kmsConfig": "A String", # Output only. Specifies the KMS config to be used for volume encryption.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
+  "ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not.
+  "mountOptions": [ # Output only. Mount options of this volume
+    { # View only mount options for a volume.
+      "export": "A String", # Export string
+      "exportFull": "A String", # Full export string
+      "instructions": "A String", # Instructions for mounting
+      "protocol": "A String", # Protocol to mount with.
+    },
+  ],
+  "multipleEndpoints": True or False, # Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.
+  "name": "A String", # Identifier. Name of the volume
+  "network": "A String", # Output only. VPC Network name. Format: projects/{project}/global/networks/{network}
+  "protocols": [ # Required. Protocols required for the volume
+    "A String",
+  ],
+  "psaRange": "A String", # Output only. This field is not implemented. The values provided in this field are ignored.
+  "replicaZone": "A String", # Output only. Specifies the replica zone for regional volume.
+  "restoreParameters": { # The RestoreParameters if volume is created from a snapshot or backup. # Optional. Specifies the source of the volume to be created from.
+    "sourceBackup": "A String", # Full name of the backup resource. Format: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}
+    "sourceSnapshot": "A String", # Full name of the snapshot resource. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}
+  },
+  "restrictedActions": [ # Optional. List of actions that are restricted on this volume.
+    "A String",
+  ],
+  "securityStyle": "A String", # Optional. Security Style of the Volume
+  "serviceLevel": "A String", # Output only. Service level of the volume
+  "shareName": "A String", # Required. Share name of the volume
+  "smbSettings": [ # Optional. SMB share settings for the volume.
+    "A String",
+  ],
+  "snapReserve": 3.14, # Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.
+  "snapshotDirectory": True or False, # Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.
+  "snapshotPolicy": { # Snapshot Policy for a volume. # Optional. SnapshotPolicy for a volume.
+    "dailySchedule": { # Make a snapshot every day e.g. at 04:00, 05:20, 23:50 # Daily schedule policy.
+      "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+    "enabled": True or False, # If enabled, make snapshots automatically according to the schedules. Default is false.
+    "hourlySchedule": { # Make a snapshot every hour e.g. at 04:00, 05:00, 06:00. # Hourly schedule policy.
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+    "monthlySchedule": { # Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50 # Monthly schedule policy.
+      "daysOfMonth": "A String", # Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
+      "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+    "weeklySchedule": { # Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50 # Weekly schedule policy.
+      "day": "A String", # Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
+      "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+  },
+  "state": "A String", # Output only. State of the volume
+  "stateDetails": "A String", # Output only. State details of the volume
+  "storagePool": "A String", # Required. StoragePool name of the volume
+  "tieringPolicy": { # Defines tiering policy for the volume. # Tiering policy for the volume.
+    "coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31.
+    "tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
+  },
+  "unixPermissions": "A String", # Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.
+  "usedGib": "A String", # Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.
+  "zone": "A String", # Output only. Specifies the active zone for regional volume.
+}
+
+  volumeId: string, Required. Id of the requesting volume. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, force=None, x__xgafv=None) +
Deletes a single Volume.
+
+Args:
+  name: string, Required. Name of the volume (required)
+  force: boolean, If this field is set as true, CCFE will not block the volume resource deletion even if it has any snapshots resource. (Otherwise, the request will only work if the volume has no snapshots.)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single Volume.
+
+Args:
+  name: string, Required. Name of the volume (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Volume provides a filesystem that you can mount.
+  "activeDirectory": "A String", # Output only. Specifies the ActiveDirectory name of a SMB volume.
+  "backupConfig": { # BackupConfig contains backup related config on a volume. # BackupConfig of the volume.
+    "backupChainBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).
+    "backupPolicies": [ # Optional. When specified, schedule backups will be created based on the policy configuration.
+      "A String",
+    ],
+    "backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
+    "scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
+  },
+  "capacityGib": "A String", # Required. Capacity in GIB of the volume
+  "coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data in GiB.
+  "createTime": "A String", # Output only. Create time of the volume
+  "description": "A String", # Optional. Description of the volume
+  "encryptionType": "A String", # Output only. Specified the current volume encryption key source.
+  "exportPolicy": { # Defines the export policy for the volume. # Optional. Export policy of the volume
+    "rules": [ # Required. List of export policy rules
+      { # An export policy rule describing various export options.
+        "accessType": "A String", # Access type (ReadWrite, ReadOnly, None)
+        "allowedClients": "A String", # Comma separated list of allowed clients IP addresses
+        "hasRootAccess": "A String", # Whether Unix root access will be granted.
+        "kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
+        "kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled.
+        "kerberos5iReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
+        "kerberos5iReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value be ignored if this is enabled.
+        "kerberos5pReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
+        "kerberos5pReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value be ignored if this is enabled.
+        "nfsv3": True or False, # NFS V3 protocol.
+        "nfsv4": True or False, # NFS V4 protocol.
+      },
+    ],
+  },
+  "hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship.
+  "kerberosEnabled": True or False, # Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
+  "kmsConfig": "A String", # Output only. Specifies the KMS config to be used for volume encryption.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
+  "ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not.
+  "mountOptions": [ # Output only. Mount options of this volume
+    { # View only mount options for a volume.
+      "export": "A String", # Export string
+      "exportFull": "A String", # Full export string
+      "instructions": "A String", # Instructions for mounting
+      "protocol": "A String", # Protocol to mount with.
+    },
+  ],
+  "multipleEndpoints": True or False, # Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.
+  "name": "A String", # Identifier. Name of the volume
+  "network": "A String", # Output only. VPC Network name. Format: projects/{project}/global/networks/{network}
+  "protocols": [ # Required. Protocols required for the volume
+    "A String",
+  ],
+  "psaRange": "A String", # Output only. This field is not implemented. The values provided in this field are ignored.
+  "replicaZone": "A String", # Output only. Specifies the replica zone for regional volume.
+  "restoreParameters": { # The RestoreParameters if volume is created from a snapshot or backup. # Optional. Specifies the source of the volume to be created from.
+    "sourceBackup": "A String", # Full name of the backup resource. Format: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}
+    "sourceSnapshot": "A String", # Full name of the snapshot resource. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}
+  },
+  "restrictedActions": [ # Optional. List of actions that are restricted on this volume.
+    "A String",
+  ],
+  "securityStyle": "A String", # Optional. Security Style of the Volume
+  "serviceLevel": "A String", # Output only. Service level of the volume
+  "shareName": "A String", # Required. Share name of the volume
+  "smbSettings": [ # Optional. SMB share settings for the volume.
+    "A String",
+  ],
+  "snapReserve": 3.14, # Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.
+  "snapshotDirectory": True or False, # Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.
+  "snapshotPolicy": { # Snapshot Policy for a volume. # Optional. SnapshotPolicy for a volume.
+    "dailySchedule": { # Make a snapshot every day e.g. at 04:00, 05:20, 23:50 # Daily schedule policy.
+      "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+    "enabled": True or False, # If enabled, make snapshots automatically according to the schedules. Default is false.
+    "hourlySchedule": { # Make a snapshot every hour e.g. at 04:00, 05:00, 06:00. # Hourly schedule policy.
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+    "monthlySchedule": { # Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50 # Monthly schedule policy.
+      "daysOfMonth": "A String", # Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
+      "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+    "weeklySchedule": { # Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50 # Weekly schedule policy.
+      "day": "A String", # Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
+      "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+  },
+  "state": "A String", # Output only. State of the volume
+  "stateDetails": "A String", # Output only. State details of the volume
+  "storagePool": "A String", # Required. StoragePool name of the volume
+  "tieringPolicy": { # Defines tiering policy for the volume. # Tiering policy for the volume.
+    "coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31.
+    "tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
+  },
+  "unixPermissions": "A String", # Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.
+  "usedGib": "A String", # Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.
+  "zone": "A String", # Output only. Specifies the active zone for regional volume.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Volumes in a given project.
+
+Args:
+  parent: string, Required. Parent value for ListVolumesRequest (required)
+  filter: string, Filtering results
+  orderBy: string, Hint for how to order the results
+  pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+  pageToken: string, A token identifying a page of results the server should return.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing Volumes
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+  "volumes": [ # The list of Volume
+    { # Volume provides a filesystem that you can mount.
+      "activeDirectory": "A String", # Output only. Specifies the ActiveDirectory name of a SMB volume.
+      "backupConfig": { # BackupConfig contains backup related config on a volume. # BackupConfig of the volume.
+        "backupChainBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).
+        "backupPolicies": [ # Optional. When specified, schedule backups will be created based on the policy configuration.
+          "A String",
+        ],
+        "backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
+        "scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
+      },
+      "capacityGib": "A String", # Required. Capacity in GIB of the volume
+      "coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data in GiB.
+      "createTime": "A String", # Output only. Create time of the volume
+      "description": "A String", # Optional. Description of the volume
+      "encryptionType": "A String", # Output only. Specified the current volume encryption key source.
+      "exportPolicy": { # Defines the export policy for the volume. # Optional. Export policy of the volume
+        "rules": [ # Required. List of export policy rules
+          { # An export policy rule describing various export options.
+            "accessType": "A String", # Access type (ReadWrite, ReadOnly, None)
+            "allowedClients": "A String", # Comma separated list of allowed clients IP addresses
+            "hasRootAccess": "A String", # Whether Unix root access will be granted.
+            "kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
+            "kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled.
+            "kerberos5iReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
+            "kerberos5iReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value be ignored if this is enabled.
+            "kerberos5pReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
+            "kerberos5pReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value be ignored if this is enabled.
+            "nfsv3": True or False, # NFS V3 protocol.
+            "nfsv4": True or False, # NFS V4 protocol.
+          },
+        ],
+      },
+      "hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship.
+      "kerberosEnabled": True or False, # Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
+      "kmsConfig": "A String", # Output only. Specifies the KMS config to be used for volume encryption.
+      "labels": { # Optional. Labels as key value pairs
+        "a_key": "A String",
+      },
+      "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
+      "ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not.
+      "mountOptions": [ # Output only. Mount options of this volume
+        { # View only mount options for a volume.
+          "export": "A String", # Export string
+          "exportFull": "A String", # Full export string
+          "instructions": "A String", # Instructions for mounting
+          "protocol": "A String", # Protocol to mount with.
+        },
+      ],
+      "multipleEndpoints": True or False, # Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.
+      "name": "A String", # Identifier. Name of the volume
+      "network": "A String", # Output only. VPC Network name. Format: projects/{project}/global/networks/{network}
+      "protocols": [ # Required. Protocols required for the volume
+        "A String",
+      ],
+      "psaRange": "A String", # Output only. This field is not implemented. The values provided in this field are ignored.
+      "replicaZone": "A String", # Output only. Specifies the replica zone for regional volume.
+      "restoreParameters": { # The RestoreParameters if volume is created from a snapshot or backup. # Optional. Specifies the source of the volume to be created from.
+        "sourceBackup": "A String", # Full name of the backup resource. Format: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}
+        "sourceSnapshot": "A String", # Full name of the snapshot resource. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}
+      },
+      "restrictedActions": [ # Optional. List of actions that are restricted on this volume.
+        "A String",
+      ],
+      "securityStyle": "A String", # Optional. Security Style of the Volume
+      "serviceLevel": "A String", # Output only. Service level of the volume
+      "shareName": "A String", # Required. Share name of the volume
+      "smbSettings": [ # Optional. SMB share settings for the volume.
+        "A String",
+      ],
+      "snapReserve": 3.14, # Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.
+      "snapshotDirectory": True or False, # Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.
+      "snapshotPolicy": { # Snapshot Policy for a volume. # Optional. SnapshotPolicy for a volume.
+        "dailySchedule": { # Make a snapshot every day e.g. at 04:00, 05:20, 23:50 # Daily schedule policy.
+          "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+          "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+          "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+        },
+        "enabled": True or False, # If enabled, make snapshots automatically according to the schedules. Default is false.
+        "hourlySchedule": { # Make a snapshot every hour e.g. at 04:00, 05:00, 06:00. # Hourly schedule policy.
+          "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+          "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+        },
+        "monthlySchedule": { # Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50 # Monthly schedule policy.
+          "daysOfMonth": "A String", # Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
+          "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+          "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+          "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+        },
+        "weeklySchedule": { # Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50 # Weekly schedule policy.
+          "day": "A String", # Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
+          "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+          "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+          "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+        },
+      },
+      "state": "A String", # Output only. State of the volume
+      "stateDetails": "A String", # Output only. State details of the volume
+      "storagePool": "A String", # Required. StoragePool name of the volume
+      "tieringPolicy": { # Defines tiering policy for the volume. # Tiering policy for the volume.
+        "coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31.
+        "tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
+      },
+      "unixPermissions": "A String", # Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.
+      "usedGib": "A String", # Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.
+      "zone": "A String", # Output only. Specifies the active zone for regional volume.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the parameters of a single Volume.
+
+Args:
+  name: string, Identifier. Name of the volume (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Volume provides a filesystem that you can mount.
+  "activeDirectory": "A String", # Output only. Specifies the ActiveDirectory name of a SMB volume.
+  "backupConfig": { # BackupConfig contains backup related config on a volume. # BackupConfig of the volume.
+    "backupChainBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).
+    "backupPolicies": [ # Optional. When specified, schedule backups will be created based on the policy configuration.
+      "A String",
+    ],
+    "backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
+    "scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
+  },
+  "capacityGib": "A String", # Required. Capacity in GIB of the volume
+  "coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data in GiB.
+  "createTime": "A String", # Output only. Create time of the volume
+  "description": "A String", # Optional. Description of the volume
+  "encryptionType": "A String", # Output only. Specified the current volume encryption key source.
+  "exportPolicy": { # Defines the export policy for the volume. # Optional. Export policy of the volume
+    "rules": [ # Required. List of export policy rules
+      { # An export policy rule describing various export options.
+        "accessType": "A String", # Access type (ReadWrite, ReadOnly, None)
+        "allowedClients": "A String", # Comma separated list of allowed clients IP addresses
+        "hasRootAccess": "A String", # Whether Unix root access will be granted.
+        "kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
+        "kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled.
+        "kerberos5iReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
+        "kerberos5iReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value be ignored if this is enabled.
+        "kerberos5pReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
+        "kerberos5pReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value be ignored if this is enabled.
+        "nfsv3": True or False, # NFS V3 protocol.
+        "nfsv4": True or False, # NFS V4 protocol.
+      },
+    ],
+  },
+  "hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship.
+  "kerberosEnabled": True or False, # Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
+  "kmsConfig": "A String", # Output only. Specifies the KMS config to be used for volume encryption.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
+  "ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not.
+  "mountOptions": [ # Output only. Mount options of this volume
+    { # View only mount options for a volume.
+      "export": "A String", # Export string
+      "exportFull": "A String", # Full export string
+      "instructions": "A String", # Instructions for mounting
+      "protocol": "A String", # Protocol to mount with.
+    },
+  ],
+  "multipleEndpoints": True or False, # Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.
+  "name": "A String", # Identifier. Name of the volume
+  "network": "A String", # Output only. VPC Network name. Format: projects/{project}/global/networks/{network}
+  "protocols": [ # Required. Protocols required for the volume
+    "A String",
+  ],
+  "psaRange": "A String", # Output only. This field is not implemented. The values provided in this field are ignored.
+  "replicaZone": "A String", # Output only. Specifies the replica zone for regional volume.
+  "restoreParameters": { # The RestoreParameters if volume is created from a snapshot or backup. # Optional. Specifies the source of the volume to be created from.
+    "sourceBackup": "A String", # Full name of the backup resource. Format: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}
+    "sourceSnapshot": "A String", # Full name of the snapshot resource. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}
+  },
+  "restrictedActions": [ # Optional. List of actions that are restricted on this volume.
+    "A String",
+  ],
+  "securityStyle": "A String", # Optional. Security Style of the Volume
+  "serviceLevel": "A String", # Output only. Service level of the volume
+  "shareName": "A String", # Required. Share name of the volume
+  "smbSettings": [ # Optional. SMB share settings for the volume.
+    "A String",
+  ],
+  "snapReserve": 3.14, # Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.
+  "snapshotDirectory": True or False, # Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.
+  "snapshotPolicy": { # Snapshot Policy for a volume. # Optional. SnapshotPolicy for a volume.
+    "dailySchedule": { # Make a snapshot every day e.g. at 04:00, 05:20, 23:50 # Daily schedule policy.
+      "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+    "enabled": True or False, # If enabled, make snapshots automatically according to the schedules. Default is false.
+    "hourlySchedule": { # Make a snapshot every hour e.g. at 04:00, 05:00, 06:00. # Hourly schedule policy.
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+    "monthlySchedule": { # Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50 # Monthly schedule policy.
+      "daysOfMonth": "A String", # Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
+      "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+    "weeklySchedule": { # Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50 # Weekly schedule policy.
+      "day": "A String", # Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
+      "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+  },
+  "state": "A String", # Output only. State of the volume
+  "stateDetails": "A String", # Output only. State details of the volume
+  "storagePool": "A String", # Required. StoragePool name of the volume
+  "tieringPolicy": { # Defines tiering policy for the volume. # Tiering policy for the volume.
+    "coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31.
+    "tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
+  },
+  "unixPermissions": "A String", # Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.
+  "usedGib": "A String", # Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.
+  "zone": "A String", # Output only. Specifies the active zone for regional volume.
+}
+
+  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Volume resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ revert(name, body=None, x__xgafv=None) +
Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created.
+
+Args:
+  name: string, Required. The resource name of the volume, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # RevertVolumeRequest reverts the given volume to the specified snapshot.
+  "snapshotId": "A String", # Required. The snapshot resource ID, in the format 'my-snapshot', where the specified ID is the {snapshot_id} of the fully qualified name like projects/{project_id}/locations/{location_id}/volumes/{volume_id}/snapshots/{snapshot_id}
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1.projects.locations.volumes.replications.html b/docs/dyn/netapp_v1.projects.locations.volumes.replications.html new file mode 100644 index 0000000000..b774dea036 --- /dev/null +++ b/docs/dyn/netapp_v1.projects.locations.volumes.replications.html @@ -0,0 +1,538 @@ + + + +

NetApp API . projects . locations . volumes . replications

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Create a new replication for a volume.

+

+ delete(name, x__xgafv=None)

+

Deletes a replication.

+

+ get(name, x__xgafv=None)

+

Describe a replication for a volume.

+

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

+

Returns descriptions of all replications for a volume.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the settings of a specific replication.

+

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

+

Resume Cross Region Replication.

+

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

+

Reverses direction of replication. Source becomes destination and destination becomes source.

+

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

+

Stop Cross Region Replication.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, replicationId=None, x__xgafv=None) +
Create a new replication for a volume.
+
+Args:
+  parent: string, Required. The NetApp volume to create the replications of, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.
+  "createTime": "A String", # Output only. Replication create time.
+  "description": "A String", # A description about this replication relationship.
+  "destinationVolume": "A String", # Output only. Full name of destination volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
+  "destinationVolumeParameters": { # DestinationVolumeParameters specify input parameters used for creating destination volume. # Required. Input only. Destination volume parameters
+    "description": "A String", # Description for the destination volume.
+    "shareName": "A String", # Destination volume's share name. If not specified, source volume's share name will be used.
+    "storagePool": "A String", # Required. Existing destination StoragePool name.
+    "volumeId": "A String", # Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
+  },
+  "healthy": True or False, # Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "mirrorState": "A String", # Output only. Indicates the state of mirroring.
+  "name": "A String", # Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
+  "replicationSchedule": "A String", # Required. Indicates the schedule for replication.
+  "role": "A String", # Output only. Indicates whether this points to source or destination.
+  "sourceVolume": "A String", # Output only. Full name of source volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
+  "state": "A String", # Output only. State of the replication.
+  "stateDetails": "A String", # Output only. State details of the replication.
+  "transferStats": { # TransferStats reports all statistics related to replication transfer. # Output only. Replication transfer statistics.
+    "lagDuration": "A String", # Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.
+    "lastTransferBytes": "A String", # Last transfer size in bytes.
+    "lastTransferDuration": "A String", # Time taken during last transfer.
+    "lastTransferEndTime": "A String", # Time when last transfer completed.
+    "lastTransferError": "A String", # A message describing the cause of the last transfer failure.
+    "totalTransferDuration": "A String", # Cumulative time taken across all transfers for the replication relationship.
+    "transferBytes": "A String", # Cumulative bytes trasferred so far for the replication relatinonship.
+    "updateTime": "A String", # Time when progress was updated last.
+  },
+}
+
+  replicationId: string, Required. ID of the replication to create. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a replication.
+
+Args:
+  name: string, Required. The replication resource name, in the format `projects/*/locations/*/volumes/*/replications/{replication_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Describe a replication for a volume.
+
+Args:
+  name: string, Required. The replication resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.
+  "createTime": "A String", # Output only. Replication create time.
+  "description": "A String", # A description about this replication relationship.
+  "destinationVolume": "A String", # Output only. Full name of destination volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
+  "destinationVolumeParameters": { # DestinationVolumeParameters specify input parameters used for creating destination volume. # Required. Input only. Destination volume parameters
+    "description": "A String", # Description for the destination volume.
+    "shareName": "A String", # Destination volume's share name. If not specified, source volume's share name will be used.
+    "storagePool": "A String", # Required. Existing destination StoragePool name.
+    "volumeId": "A String", # Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
+  },
+  "healthy": True or False, # Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "mirrorState": "A String", # Output only. Indicates the state of mirroring.
+  "name": "A String", # Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
+  "replicationSchedule": "A String", # Required. Indicates the schedule for replication.
+  "role": "A String", # Output only. Indicates whether this points to source or destination.
+  "sourceVolume": "A String", # Output only. Full name of source volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
+  "state": "A String", # Output only. State of the replication.
+  "stateDetails": "A String", # Output only. State details of the replication.
+  "transferStats": { # TransferStats reports all statistics related to replication transfer. # Output only. Replication transfer statistics.
+    "lagDuration": "A String", # Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.
+    "lastTransferBytes": "A String", # Last transfer size in bytes.
+    "lastTransferDuration": "A String", # Time taken during last transfer.
+    "lastTransferEndTime": "A String", # Time when last transfer completed.
+    "lastTransferError": "A String", # A message describing the cause of the last transfer failure.
+    "totalTransferDuration": "A String", # Cumulative time taken across all transfers for the replication relationship.
+    "transferBytes": "A String", # Cumulative bytes trasferred so far for the replication relatinonship.
+    "updateTime": "A String", # Time when progress was updated last.
+  },
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns descriptions of all replications for a volume.
+
+Args:
+  parent: string, Required. The volume for which to retrieve replication information, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`. (required)
+  filter: string, List filter.
+  orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
+  pageSize: integer, The maximum number of items to return.
+  pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ListReplicationsResponse is the result of ListReplicationsRequest.
+  "nextPageToken": "A String", # The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
+  "replications": [ # A list of replications in the project for the specified volume.
+    { # Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.
+      "createTime": "A String", # Output only. Replication create time.
+      "description": "A String", # A description about this replication relationship.
+      "destinationVolume": "A String", # Output only. Full name of destination volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
+      "destinationVolumeParameters": { # DestinationVolumeParameters specify input parameters used for creating destination volume. # Required. Input only. Destination volume parameters
+        "description": "A String", # Description for the destination volume.
+        "shareName": "A String", # Destination volume's share name. If not specified, source volume's share name will be used.
+        "storagePool": "A String", # Required. Existing destination StoragePool name.
+        "volumeId": "A String", # Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
+      },
+      "healthy": True or False, # Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
+      "labels": { # Resource labels to represent user provided metadata.
+        "a_key": "A String",
+      },
+      "mirrorState": "A String", # Output only. Indicates the state of mirroring.
+      "name": "A String", # Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
+      "replicationSchedule": "A String", # Required. Indicates the schedule for replication.
+      "role": "A String", # Output only. Indicates whether this points to source or destination.
+      "sourceVolume": "A String", # Output only. Full name of source volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
+      "state": "A String", # Output only. State of the replication.
+      "stateDetails": "A String", # Output only. State details of the replication.
+      "transferStats": { # TransferStats reports all statistics related to replication transfer. # Output only. Replication transfer statistics.
+        "lagDuration": "A String", # Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.
+        "lastTransferBytes": "A String", # Last transfer size in bytes.
+        "lastTransferDuration": "A String", # Time taken during last transfer.
+        "lastTransferEndTime": "A String", # Time when last transfer completed.
+        "lastTransferError": "A String", # A message describing the cause of the last transfer failure.
+        "totalTransferDuration": "A String", # Cumulative time taken across all transfers for the replication relationship.
+        "transferBytes": "A String", # Cumulative bytes trasferred so far for the replication relatinonship.
+        "updateTime": "A String", # Time when progress was updated last.
+      },
+    },
+  ],
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the settings of a specific replication.
+
+Args:
+  name: string, Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.
+  "createTime": "A String", # Output only. Replication create time.
+  "description": "A String", # A description about this replication relationship.
+  "destinationVolume": "A String", # Output only. Full name of destination volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
+  "destinationVolumeParameters": { # DestinationVolumeParameters specify input parameters used for creating destination volume. # Required. Input only. Destination volume parameters
+    "description": "A String", # Description for the destination volume.
+    "shareName": "A String", # Destination volume's share name. If not specified, source volume's share name will be used.
+    "storagePool": "A String", # Required. Existing destination StoragePool name.
+    "volumeId": "A String", # Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
+  },
+  "healthy": True or False, # Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "mirrorState": "A String", # Output only. Indicates the state of mirroring.
+  "name": "A String", # Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
+  "replicationSchedule": "A String", # Required. Indicates the schedule for replication.
+  "role": "A String", # Output only. Indicates whether this points to source or destination.
+  "sourceVolume": "A String", # Output only. Full name of source volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
+  "state": "A String", # Output only. State of the replication.
+  "stateDetails": "A String", # Output only. State details of the replication.
+  "transferStats": { # TransferStats reports all statistics related to replication transfer. # Output only. Replication transfer statistics.
+    "lagDuration": "A String", # Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.
+    "lastTransferBytes": "A String", # Last transfer size in bytes.
+    "lastTransferDuration": "A String", # Time taken during last transfer.
+    "lastTransferEndTime": "A String", # Time when last transfer completed.
+    "lastTransferError": "A String", # A message describing the cause of the last transfer failure.
+    "totalTransferDuration": "A String", # Cumulative time taken across all transfers for the replication relationship.
+    "transferBytes": "A String", # Cumulative bytes trasferred so far for the replication relatinonship.
+    "updateTime": "A String", # Time when progress was updated last.
+  },
+}
+
+  updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ resume(name, body=None, x__xgafv=None) +
Resume Cross Region Replication.
+
+Args:
+  name: string, Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # ResumeReplicationRequest resumes a stopped replication.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ reverseDirection(name, body=None, x__xgafv=None) +
Reverses direction of replication. Source becomes destination and destination becomes source.
+
+Args:
+  name: string, Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # ReverseReplicationDirectionRequest reverses direction of replication. Source becomes destination and destination becomes source.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ stop(name, body=None, x__xgafv=None) +
Stop Cross Region Replication.
+
+Args:
+  name: string, Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # StopReplicationRequest stops a replication until resumed.
+  "force": True or False, # Indicates whether to stop replication forcefully while data transfer is in progress. Warning! if force is true, this will abort any current transfers and can lead to data loss due to partial transfer. If force is false, stop replication will fail while data transfer is in progress and you will need to retry later.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1.projects.locations.volumes.snapshots.html b/docs/dyn/netapp_v1.projects.locations.volumes.snapshots.html new file mode 100644 index 0000000000..e00da08c67 --- /dev/null +++ b/docs/dyn/netapp_v1.projects.locations.volumes.snapshots.html @@ -0,0 +1,321 @@ + + + +

NetApp API . projects . locations . volumes . snapshots

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Create a new snapshot for a volume.

+

+ delete(name, x__xgafv=None)

+

Deletes a snapshot.

+

+ get(name, x__xgafv=None)

+

Describe a snapshot for a volume.

+

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

+

Returns descriptions of all snapshots for a volume.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the settings of a specific snapshot.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, snapshotId=None, x__xgafv=None) +
Create a new snapshot for a volume.
+
+Args:
+  parent: string, Required. The NetApp volume to create the snapshots of, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Snapshot is a point-in-time version of a Volume's content.
+  "createTime": "A String", # Output only. The time when the snapshot was created.
+  "description": "A String", # A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the snapshot. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`.
+  "state": "A String", # Output only. The snapshot state.
+  "stateDetails": "A String", # Output only. State details of the storage pool
+  "usedBytes": 3.14, # Output only. Current storage usage for the snapshot in bytes.
+}
+
+  snapshotId: string, Required. ID of the snapshot to create. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a snapshot.
+
+Args:
+  name: string, Required. The snapshot resource name, in the format `projects/*/locations/*/volumes/*/snapshots/{snapshot_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Describe a snapshot for a volume.
+
+Args:
+  name: string, Required. The snapshot resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Snapshot is a point-in-time version of a Volume's content.
+  "createTime": "A String", # Output only. The time when the snapshot was created.
+  "description": "A String", # A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the snapshot. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`.
+  "state": "A String", # Output only. The snapshot state.
+  "stateDetails": "A String", # Output only. State details of the storage pool
+  "usedBytes": 3.14, # Output only. Current storage usage for the snapshot in bytes.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns descriptions of all snapshots for a volume.
+
+Args:
+  parent: string, Required. The volume for which to retrieve snapshot information, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`. (required)
+  filter: string, List filter.
+  orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
+  pageSize: integer, The maximum number of items to return.
+  pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ListSnapshotsResponse is the result of ListSnapshotsRequest.
+  "nextPageToken": "A String", # The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
+  "snapshots": [ # A list of snapshots in the project for the specified volume.
+    { # Snapshot is a point-in-time version of a Volume's content.
+      "createTime": "A String", # Output only. The time when the snapshot was created.
+      "description": "A String", # A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.
+      "labels": { # Resource labels to represent user provided metadata.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name of the snapshot. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`.
+      "state": "A String", # Output only. The snapshot state.
+      "stateDetails": "A String", # Output only. State details of the storage pool
+      "usedBytes": 3.14, # Output only. Current storage usage for the snapshot in bytes.
+    },
+  ],
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the settings of a specific snapshot.
+
+Args:
+  name: string, Identifier. The resource name of the snapshot. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Snapshot is a point-in-time version of a Volume's content.
+  "createTime": "A String", # Output only. The time when the snapshot was created.
+  "description": "A String", # A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the snapshot. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`.
+  "state": "A String", # Output only. The snapshot state.
+  "stateDetails": "A String", # Output only. State details of the storage pool
+  "usedBytes": 3.14, # Output only. Current storage usage for the snapshot in bytes.
+}
+
+  updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1beta1.html b/docs/dyn/netapp_v1beta1.html new file mode 100644 index 0000000000..f2c5071d91 --- /dev/null +++ b/docs/dyn/netapp_v1beta1.html @@ -0,0 +1,111 @@ + + + +

NetApp API

+

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

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

NetApp API . projects

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1beta1.projects.locations.activeDirectories.html b/docs/dyn/netapp_v1beta1.projects.locations.activeDirectories.html new file mode 100644 index 0000000000..167b36e0de --- /dev/null +++ b/docs/dyn/netapp_v1beta1.projects.locations.activeDirectories.html @@ -0,0 +1,405 @@ + + + +

NetApp API . projects . locations . activeDirectories

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

CreateActiveDirectory Creates the active directory specified in the request.

+

+ delete(name, x__xgafv=None)

+

Delete the active directory specified in the request.

+

+ get(name, x__xgafv=None)

+

Describes a specified active directory.

+

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

+

Lists active directories.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update the parameters of an active directories.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, activeDirectoryId=None, body=None, x__xgafv=None) +
CreateActiveDirectory Creates the active directory specified in the request.
+
+Args:
+  parent: string, Required. Value for parent. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # ActiveDirectory is the public representation of the active directory config.
+  "administrators": [ # Optional. Users to be added to the Built-in Admininstrators group.
+    "A String",
+  ],
+  "aesEncryption": True or False, # If enabled, AES encryption will be enabled for SMB communication.
+  "backupOperators": [ # Optional. Users to be added to the Built-in Backup Operator active directory group.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Create time of the active directory.
+  "description": "A String", # Description of the active directory.
+  "dns": "A String", # Required. Comma separated list of DNS server IP addresses for the Active Directory domain.
+  "domain": "A String", # Required. Name of the Active Directory domain
+  "encryptDcConnections": True or False, # If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.
+  "kdcHostname": "A String", # Name of the active directory machine. This optional parameter is used only while creating kerberos volume
+  "kdcIp": "A String", # KDC server IP address for the active directory machine.
+  "labels": { # Labels for the active directory.
+    "a_key": "A String",
+  },
+  "ldapSigning": True or False, # Specifies whether or not the LDAP traffic needs to be signed.
+  "name": "A String", # Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.
+  "netBiosPrefix": "A String", # Required. NetBIOSPrefix is used as a prefix for SMB server name.
+  "nfsUsersWithLdap": True or False, # If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.
+  "organizationalUnit": "A String", # The Organizational Unit (OU) within the Windows Active Directory the user belongs to.
+  "password": "A String", # Required. Password of the Active Directory domain administrator.
+  "securityOperators": [ # Optional. Domain users to be given the SeSecurityPrivilege.
+    "A String",
+  ],
+  "site": "A String", # The Active Directory site the service will limit Domain Controller discovery too.
+  "state": "A String", # Output only. The state of the AD.
+  "stateDetails": "A String", # Output only. The state details of the Active Directory.
+  "username": "A String", # Required. Username of the Active Directory domain administrator.
+}
+
+  activeDirectoryId: string, Required. ID of the active directory to create. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter , the last a letter or a number, and a 63 character maximum.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Delete the active directory specified in the request.
+
+Args:
+  name: string, Required. Name of the active directory. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Describes a specified active directory.
+
+Args:
+  name: string, Required. Name of the active directory. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ActiveDirectory is the public representation of the active directory config.
+  "administrators": [ # Optional. Users to be added to the Built-in Admininstrators group.
+    "A String",
+  ],
+  "aesEncryption": True or False, # If enabled, AES encryption will be enabled for SMB communication.
+  "backupOperators": [ # Optional. Users to be added to the Built-in Backup Operator active directory group.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Create time of the active directory.
+  "description": "A String", # Description of the active directory.
+  "dns": "A String", # Required. Comma separated list of DNS server IP addresses for the Active Directory domain.
+  "domain": "A String", # Required. Name of the Active Directory domain
+  "encryptDcConnections": True or False, # If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.
+  "kdcHostname": "A String", # Name of the active directory machine. This optional parameter is used only while creating kerberos volume
+  "kdcIp": "A String", # KDC server IP address for the active directory machine.
+  "labels": { # Labels for the active directory.
+    "a_key": "A String",
+  },
+  "ldapSigning": True or False, # Specifies whether or not the LDAP traffic needs to be signed.
+  "name": "A String", # Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.
+  "netBiosPrefix": "A String", # Required. NetBIOSPrefix is used as a prefix for SMB server name.
+  "nfsUsersWithLdap": True or False, # If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.
+  "organizationalUnit": "A String", # The Organizational Unit (OU) within the Windows Active Directory the user belongs to.
+  "password": "A String", # Required. Password of the Active Directory domain administrator.
+  "securityOperators": [ # Optional. Domain users to be given the SeSecurityPrivilege.
+    "A String",
+  ],
+  "site": "A String", # The Active Directory site the service will limit Domain Controller discovery too.
+  "state": "A String", # Output only. The state of the AD.
+  "stateDetails": "A String", # Output only. The state details of the Active Directory.
+  "username": "A String", # Required. Username of the Active Directory domain administrator.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists active directories.
+
+Args:
+  parent: string, Required. Parent value for ListActiveDirectoriesRequest (required)
+  filter: string, Filtering results
+  orderBy: string, Hint for how to order the results
+  pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+  pageToken: string, A token identifying a page of results the server should return.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ListActiveDirectoriesResponse contains all the active directories requested.
+  "activeDirectories": [ # The list of active directories.
+    { # ActiveDirectory is the public representation of the active directory config.
+      "administrators": [ # Optional. Users to be added to the Built-in Admininstrators group.
+        "A String",
+      ],
+      "aesEncryption": True or False, # If enabled, AES encryption will be enabled for SMB communication.
+      "backupOperators": [ # Optional. Users to be added to the Built-in Backup Operator active directory group.
+        "A String",
+      ],
+      "createTime": "A String", # Output only. Create time of the active directory.
+      "description": "A String", # Description of the active directory.
+      "dns": "A String", # Required. Comma separated list of DNS server IP addresses for the Active Directory domain.
+      "domain": "A String", # Required. Name of the Active Directory domain
+      "encryptDcConnections": True or False, # If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.
+      "kdcHostname": "A String", # Name of the active directory machine. This optional parameter is used only while creating kerberos volume
+      "kdcIp": "A String", # KDC server IP address for the active directory machine.
+      "labels": { # Labels for the active directory.
+        "a_key": "A String",
+      },
+      "ldapSigning": True or False, # Specifies whether or not the LDAP traffic needs to be signed.
+      "name": "A String", # Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.
+      "netBiosPrefix": "A String", # Required. NetBIOSPrefix is used as a prefix for SMB server name.
+      "nfsUsersWithLdap": True or False, # If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.
+      "organizationalUnit": "A String", # The Organizational Unit (OU) within the Windows Active Directory the user belongs to.
+      "password": "A String", # Required. Password of the Active Directory domain administrator.
+      "securityOperators": [ # Optional. Domain users to be given the SeSecurityPrivilege.
+        "A String",
+      ],
+      "site": "A String", # The Active Directory site the service will limit Domain Controller discovery too.
+      "state": "A String", # Output only. The state of the AD.
+      "stateDetails": "A String", # Output only. The state details of the Active Directory.
+      "username": "A String", # Required. Username of the Active Directory domain administrator.
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Update the parameters of an active directories.
+
+Args:
+  name: string, Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # ActiveDirectory is the public representation of the active directory config.
+  "administrators": [ # Optional. Users to be added to the Built-in Admininstrators group.
+    "A String",
+  ],
+  "aesEncryption": True or False, # If enabled, AES encryption will be enabled for SMB communication.
+  "backupOperators": [ # Optional. Users to be added to the Built-in Backup Operator active directory group.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Create time of the active directory.
+  "description": "A String", # Description of the active directory.
+  "dns": "A String", # Required. Comma separated list of DNS server IP addresses for the Active Directory domain.
+  "domain": "A String", # Required. Name of the Active Directory domain
+  "encryptDcConnections": True or False, # If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.
+  "kdcHostname": "A String", # Name of the active directory machine. This optional parameter is used only while creating kerberos volume
+  "kdcIp": "A String", # KDC server IP address for the active directory machine.
+  "labels": { # Labels for the active directory.
+    "a_key": "A String",
+  },
+  "ldapSigning": True or False, # Specifies whether or not the LDAP traffic needs to be signed.
+  "name": "A String", # Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.
+  "netBiosPrefix": "A String", # Required. NetBIOSPrefix is used as a prefix for SMB server name.
+  "nfsUsersWithLdap": True or False, # If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.
+  "organizationalUnit": "A String", # The Organizational Unit (OU) within the Windows Active Directory the user belongs to.
+  "password": "A String", # Required. Password of the Active Directory domain administrator.
+  "securityOperators": [ # Optional. Domain users to be given the SeSecurityPrivilege.
+    "A String",
+  ],
+  "site": "A String", # The Active Directory site the service will limit Domain Controller discovery too.
+  "state": "A String", # Output only. The state of the AD.
+  "stateDetails": "A String", # Output only. The state details of the Active Directory.
+  "username": "A String", # Required. Username of the Active Directory domain administrator.
+}
+
+  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Active Directory resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1beta1.projects.locations.backupPolicies.html b/docs/dyn/netapp_v1beta1.projects.locations.backupPolicies.html new file mode 100644 index 0000000000..e4face7633 --- /dev/null +++ b/docs/dyn/netapp_v1beta1.projects.locations.backupPolicies.html @@ -0,0 +1,333 @@ + + + +

NetApp API . projects . locations . backupPolicies

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates new backup policy

+

+ delete(name, x__xgafv=None)

+

Warning! This operation will permanently delete the backup policy.

+

+ get(name, x__xgafv=None)

+

Returns the description of the specified backup policy by backup_policy_id.

+

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

+

Returns list of all available backup policies.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates settings of a specific backup policy.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, backupPolicyId=None, body=None, x__xgafv=None) +
Creates new backup policy
+
+Args:
+  parent: string, Required. The location to create the backup policies of, in the format `projects/{project_id}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Backup Policy.
+  "assignedVolumeCount": 42, # Output only. The total number of volumes assigned by this backup policy.
+  "createTime": "A String", # Output only. The time when the backup policy was created.
+  "dailyBackupLimit": 42, # Number of daily backups to keep. Note that the minimum daily backup limit is 2.
+  "description": "A String", # Description of the backup policy.
+  "enabled": True or False, # If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "monthlyBackupLimit": 42, # Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
+  "name": "A String", # Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.
+  "state": "A String", # Output only. The backup policy state.
+  "weeklyBackupLimit": 42, # Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
+}
+
+  backupPolicyId: string, Required. The ID to use for the backup policy. The ID must be unique within the specified location. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Warning! This operation will permanently delete the backup policy.
+
+Args:
+  name: string, Required. The backup policy resource name, in the format `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Returns the description of the specified backup policy by backup_policy_id.
+
+Args:
+  name: string, Required. The backupPolicy resource name, in the format `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Backup Policy.
+  "assignedVolumeCount": 42, # Output only. The total number of volumes assigned by this backup policy.
+  "createTime": "A String", # Output only. The time when the backup policy was created.
+  "dailyBackupLimit": 42, # Number of daily backups to keep. Note that the minimum daily backup limit is 2.
+  "description": "A String", # Description of the backup policy.
+  "enabled": True or False, # If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "monthlyBackupLimit": 42, # Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
+  "name": "A String", # Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.
+  "state": "A String", # Output only. The backup policy state.
+  "weeklyBackupLimit": 42, # Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns list of all available backup policies.
+
+Args:
+  parent: string, Required. Parent value for ListBackupPoliciesRequest (required)
+  filter: string, Filtering results
+  orderBy: string, Hint for how to order the results
+  pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+  pageToken: string, A token identifying a page of results the server should return.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ListBackupPoliciesResponse contains all the backup policies requested.
+  "backupPolicies": [ # The list of backup policies.
+    { # Backup Policy.
+      "assignedVolumeCount": 42, # Output only. The total number of volumes assigned by this backup policy.
+      "createTime": "A String", # Output only. The time when the backup policy was created.
+      "dailyBackupLimit": 42, # Number of daily backups to keep. Note that the minimum daily backup limit is 2.
+      "description": "A String", # Description of the backup policy.
+      "enabled": True or False, # If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.
+      "labels": { # Resource labels to represent user provided metadata.
+        "a_key": "A String",
+      },
+      "monthlyBackupLimit": 42, # Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
+      "name": "A String", # Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.
+      "state": "A String", # Output only. The backup policy state.
+      "weeklyBackupLimit": 42, # Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates settings of a specific backup policy.
+
+Args:
+  name: string, Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Backup Policy.
+  "assignedVolumeCount": 42, # Output only. The total number of volumes assigned by this backup policy.
+  "createTime": "A String", # Output only. The time when the backup policy was created.
+  "dailyBackupLimit": 42, # Number of daily backups to keep. Note that the minimum daily backup limit is 2.
+  "description": "A String", # Description of the backup policy.
+  "enabled": True or False, # If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "monthlyBackupLimit": 42, # Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
+  "name": "A String", # Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.
+  "state": "A String", # Output only. The backup policy state.
+  "weeklyBackupLimit": 42, # Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
+}
+
+  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Backup Policy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1beta1.projects.locations.backupVaults.backups.html b/docs/dyn/netapp_v1beta1.projects.locations.backupVaults.backups.html new file mode 100644 index 0000000000..c16a23c9c2 --- /dev/null +++ b/docs/dyn/netapp_v1beta1.projects.locations.backupVaults.backups.html @@ -0,0 +1,333 @@ + + + +

NetApp API . projects . locations . backupVaults . backups

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a backup from the volume specified in the request The backup can be created from the given snapshot if specified in the request. If no snapshot specified, there'll be a new snapshot taken to initiate the backup creation.

+

+ delete(name, x__xgafv=None)

+

Warning! This operation will permanently delete the backup.

+

+ get(name, x__xgafv=None)

+

Returns the description of the specified backup

+

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

+

Returns descriptions of all backups for a backupVault.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update backup with full spec.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, backupId=None, body=None, x__xgafv=None) +
Creates a backup from the volume specified in the request The backup can be created from the given snapshot if specified in the request. If no snapshot specified, there'll be a new snapshot taken to initiate the backup creation.
+
+Args:
+  parent: string, Required. The NetApp backupVault to create the backups of, in the format `projects/*/locations/*/backupVaults/{backup_vault_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A NetApp Backup.
+  "backupType": "A String", # Output only. Type of backup, manually created or created by a backup policy.
+  "chainStorageBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
+  "createTime": "A String", # Output only. The time when the backup was created.
+  "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.
+  "sourceSnapshot": "A String", # If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`
+  "sourceVolume": "A String", # Volume full name of this backup belongs to. Format: `projects/{projects_id}/locations/{location}/volumes/{volume_id}`
+  "state": "A String", # Output only. The backup state.
+  "volumeUsageBytes": "A String", # Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
+}
+
+  backupId: string, Required. The ID to use for the backup. The ID must be unique within the specified backupVault. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Warning! This operation will permanently delete the backup.
+
+Args:
+  name: string, Required. The backup resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Returns the description of the specified backup
+
+Args:
+  name: string, Required. The backup resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A NetApp Backup.
+  "backupType": "A String", # Output only. Type of backup, manually created or created by a backup policy.
+  "chainStorageBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
+  "createTime": "A String", # Output only. The time when the backup was created.
+  "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.
+  "sourceSnapshot": "A String", # If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`
+  "sourceVolume": "A String", # Volume full name of this backup belongs to. Format: `projects/{projects_id}/locations/{location}/volumes/{volume_id}`
+  "state": "A String", # Output only. The backup state.
+  "volumeUsageBytes": "A String", # Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns descriptions of all backups for a backupVault.
+
+Args:
+  parent: string, Required. The backupVault for which to retrieve backup information, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`. To retrieve backup information for all locations, use "-" for the `{location}` value. To retrieve backup information for all backupVaults, use "-" for the `{backup_vault_id}` value. To retrieve backup information for a volume, use "-" for the `{backup_vault_id}` value and specify volume full name with the filter. (required)
+  filter: string, The standard list filter. If specified, backups will be returned based on the attribute name that matches the filter expression. If empty, then no backups are filtered out. See https://google.aip.dev/160
+  orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
+  pageSize: integer, The maximum number of items to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ListBackupsResponse is the result of ListBackupsRequest.
+  "backups": [ # A list of backups in the project.
+    { # A NetApp Backup.
+      "backupType": "A String", # Output only. Type of backup, manually created or created by a backup policy.
+      "chainStorageBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
+      "createTime": "A String", # Output only. The time when the backup was created.
+      "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
+      "labels": { # Resource labels to represent user provided metadata.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.
+      "sourceSnapshot": "A String", # If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`
+      "sourceVolume": "A String", # Volume full name of this backup belongs to. Format: `projects/{projects_id}/locations/{location}/volumes/{volume_id}`
+      "state": "A String", # Output only. The backup state.
+      "volumeUsageBytes": "A String", # Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
+    },
+  ],
+  "nextPageToken": "A String", # The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Update backup with full spec.
+
+Args:
+  name: string, Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A NetApp Backup.
+  "backupType": "A String", # Output only. Type of backup, manually created or created by a backup policy.
+  "chainStorageBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
+  "createTime": "A String", # Output only. The time when the backup was created.
+  "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.
+  "sourceSnapshot": "A String", # If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`
+  "sourceVolume": "A String", # Volume full name of this backup belongs to. Format: `projects/{projects_id}/locations/{location}/volumes/{volume_id}`
+  "state": "A String", # Output only. The backup state.
+  "volumeUsageBytes": "A String", # Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
+}
+
+  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Backup resource to be updated. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1beta1.projects.locations.backupVaults.html b/docs/dyn/netapp_v1beta1.projects.locations.backupVaults.html new file mode 100644 index 0000000000..4836bc2db1 --- /dev/null +++ b/docs/dyn/netapp_v1beta1.projects.locations.backupVaults.html @@ -0,0 +1,318 @@ + + + +

NetApp API . projects . locations . backupVaults

+

Instance Methods

+

+ backups() +

+

Returns the backups Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates new backup vault

+

+ delete(name, x__xgafv=None)

+

Warning! This operation will permanently delete the backup vault.

+

+ get(name, x__xgafv=None)

+

Returns the description of the specified backup vault

+

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

+

Returns list of all available backup vaults.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the settings of a specific backup vault.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, backupVaultId=None, body=None, x__xgafv=None) +
Creates new backup vault
+
+Args:
+  parent: string, Required. The location to create the backup vaults, in the format `projects/{project_id}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A NetApp BackupVault.
+  "createTime": "A String", # Output only. Create time of the backup vault.
+  "description": "A String", # Description of the backup vault.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.
+  "state": "A String", # Output only. The backup vault state.
+}
+
+  backupVaultId: string, Required. The ID to use for the backupVault. The ID must be unique within the specified location. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Warning! This operation will permanently delete the backup vault.
+
+Args:
+  name: string, Required. The backupVault resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Returns the description of the specified backup vault
+
+Args:
+  name: string, Required. The backupVault resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A NetApp BackupVault.
+  "createTime": "A String", # Output only. Create time of the backup vault.
+  "description": "A String", # Description of the backup vault.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.
+  "state": "A String", # Output only. The backup vault state.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns list of all available backup vaults.
+
+Args:
+  parent: string, Required. The location for which to retrieve backupVault information, in the format `projects/{project_id}/locations/{location}`. (required)
+  filter: string, List filter.
+  orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
+  pageSize: integer, The maximum number of items to return.
+  pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ListBackupVaultsResponse is the result of ListBackupVaultsRequest.
+  "backupVaults": [ # A list of backupVaults in the project for the specified location.
+    { # A NetApp BackupVault.
+      "createTime": "A String", # Output only. Create time of the backup vault.
+      "description": "A String", # Description of the backup vault.
+      "labels": { # Resource labels to represent user provided metadata.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.
+      "state": "A String", # Output only. The backup vault state.
+    },
+  ],
+  "nextPageToken": "A String", # The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the settings of a specific backup vault.
+
+Args:
+  name: string, Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A NetApp BackupVault.
+  "createTime": "A String", # Output only. Create time of the backup vault.
+  "description": "A String", # Description of the backup vault.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.
+  "state": "A String", # Output only. The backup vault state.
+}
+
+  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Backup resource to be updated. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1beta1.projects.locations.html b/docs/dyn/netapp_v1beta1.projects.locations.html new file mode 100644 index 0000000000..a291991646 --- /dev/null +++ b/docs/dyn/netapp_v1beta1.projects.locations.html @@ -0,0 +1,206 @@ + + + +

NetApp API . projects . locations

+

Instance Methods

+

+ activeDirectories() +

+

Returns the activeDirectories Resource.

+ +

+ backupPolicies() +

+

Returns the backupPolicies Resource.

+ +

+ backupVaults() +

+

Returns the backupVaults Resource.

+ +

+ kmsConfigs() +

+

Returns the kmsConfigs Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ storagePools() +

+

Returns the storagePools Resource.

+ +

+ volumes() +

+

Returns the volumes Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets information about a location.

+

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

+

Lists information about the supported locations for this service.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

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

NetApp API . projects . locations . kmsConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new KMS config.

+

+ delete(name, x__xgafv=None)

+

Warning! This operation will permanently delete the Kms config.

+

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

+

Encrypt the existing volumes without CMEK encryption with the desired the KMS config for the whole region.

+

+ get(name, x__xgafv=None)

+

Returns the description of the specified KMS config by kms_config_id.

+

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

+

Returns descriptions of all KMS configs owned by the caller.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the Kms config properties with the full spec

+

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

+

Verifies KMS config reachability.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, kmsConfigId=None, x__xgafv=None) +
Creates a new KMS config.
+
+Args:
+  parent: string, Required. Value for parent. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # KmsConfig is the customer managed encryption key(CMEK) configuration.
+  "createTime": "A String", # Output only. Create time of the KmsConfig.
+  "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.
+  "description": "A String", # Description of the KmsConfig.
+  "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key.
+  "labels": { # Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the KmsConfig.
+  "serviceAccount": "A String", # Output only. The Service account which will have access to the customer provided encryption key.
+  "state": "A String", # Output only. State of the KmsConfig.
+  "stateDetails": "A String", # Output only. State details of the KmsConfig.
+}
+
+  kmsConfigId: string, Required. Id of the requesting KmsConfig. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Warning! This operation will permanently delete the Kms config.
+
+Args:
+  name: string, Required. Name of the KmsConfig. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ encrypt(name, body=None, x__xgafv=None) +
Encrypt the existing volumes without CMEK encryption with the desired the KMS config for the whole region.
+
+Args:
+  name: string, Required. Name of the KmsConfig. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # EncryptVolumesRequest specifies the KMS config to encrypt existing volumes.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Returns the description of the specified KMS config by kms_config_id.
+
+Args:
+  name: string, Required. Name of the KmsConfig (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # KmsConfig is the customer managed encryption key(CMEK) configuration.
+  "createTime": "A String", # Output only. Create time of the KmsConfig.
+  "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.
+  "description": "A String", # Description of the KmsConfig.
+  "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key.
+  "labels": { # Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the KmsConfig.
+  "serviceAccount": "A String", # Output only. The Service account which will have access to the customer provided encryption key.
+  "state": "A String", # Output only. State of the KmsConfig.
+  "stateDetails": "A String", # Output only. State details of the KmsConfig.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns descriptions of all KMS configs owned by the caller.
+
+Args:
+  parent: string, Required. Parent value (required)
+  filter: string, List filter.
+  orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
+  pageSize: integer, The maximum number of items to return.
+  pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ListKmsConfigsResponse is the response to a ListKmsConfigsRequest.
+  "kmsConfigs": [ # The list of KmsConfigs
+    { # KmsConfig is the customer managed encryption key(CMEK) configuration.
+      "createTime": "A String", # Output only. Create time of the KmsConfig.
+      "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.
+      "description": "A String", # Description of the KmsConfig.
+      "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key.
+      "labels": { # Labels as key value pairs
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. Name of the KmsConfig.
+      "serviceAccount": "A String", # Output only. The Service account which will have access to the customer provided encryption key.
+      "state": "A String", # Output only. State of the KmsConfig.
+      "stateDetails": "A String", # Output only. State details of the KmsConfig.
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the Kms config properties with the full spec
+
+Args:
+  name: string, Identifier. Name of the KmsConfig. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # KmsConfig is the customer managed encryption key(CMEK) configuration.
+  "createTime": "A String", # Output only. Create time of the KmsConfig.
+  "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.
+  "description": "A String", # Description of the KmsConfig.
+  "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key.
+  "labels": { # Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the KmsConfig.
+  "serviceAccount": "A String", # Output only. The Service account which will have access to the customer provided encryption key.
+  "state": "A String", # Output only. State of the KmsConfig.
+  "stateDetails": "A String", # Output only. State details of the KmsConfig.
+}
+
+  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the KmsConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ verify(name, body=None, x__xgafv=None) +
Verifies KMS config reachability.
+
+Args:
+  name: string, Required. Name of the KMS Config to be verified. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # VerifyKmsConfigRequest specifies the KMS config to be validated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # VerifyKmsConfigResponse contains the information if the config is correctly and error message.
+  "healthError": "A String", # Output only. Error message if config is not healthy.
+  "healthy": True or False, # Output only. If the customer key configured correctly to the encrypt volume.
+  "instructions": "A String", # Output only. Instructions for the customers to provide the access to the encryption key.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1beta1.projects.locations.operations.html b/docs/dyn/netapp_v1beta1.projects.locations.operations.html new file mode 100644 index 0000000000..ab6ecfff85 --- /dev/null +++ b/docs/dyn/netapp_v1beta1.projects.locations.operations.html @@ -0,0 +1,235 @@ + + + +

NetApp API . projects . locations . operations

+

Instance Methods

+

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

+

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

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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

+

+ get(name, x__xgafv=None)

+

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

+

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

+

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

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ cancel(name, body=None, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1beta1.projects.locations.storagePools.html b/docs/dyn/netapp_v1beta1.projects.locations.storagePools.html new file mode 100644 index 0000000000..8d12973fc5 --- /dev/null +++ b/docs/dyn/netapp_v1beta1.projects.locations.storagePools.html @@ -0,0 +1,417 @@ + + + +

NetApp API . projects . locations . storagePools

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new storage pool.

+

+ delete(name, x__xgafv=None)

+

Warning! This operation will permanently delete the storage pool.

+

+ get(name, x__xgafv=None)

+

Returns the description of the specified storage pool by poolId.

+

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

+

Returns descriptions of all storage pools owned by the caller.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the storage pool properties with the full spec

+

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

+

This operation will switch the active/replica zone for a regional storagePool.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, storagePoolId=None, x__xgafv=None) +
Creates a new storage pool.
+
+Args:
+  parent: string, Required. Value for parent. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # StoragePool is a container for volumes with a service level and capacity. Volumes can be created in a pool of sufficient available capacity. StoragePool capacity is what you are billed for.
+  "activeDirectory": "A String", # Optional. Specifies the Active Directory to be used for creating a SMB volume.
+  "allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.
+  "capacityGib": "A String", # Required. Capacity in GIB of the pool
+  "createTime": "A String", # Output only. Create time of the storage pool
+  "description": "A String", # Optional. Description of the storage pool
+  "encryptionType": "A String", # Output only. Specifies the current pool encryption key source.
+  "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
+  "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "ldapEnabled": True or False, # Optional. Flag indicating if the pool is NFS LDAP enabled or not.
+  "name": "A String", # Identifier. Name of the storage pool
+  "network": "A String", # Required. VPC Network name. Format: projects/{project}/global/networks/{network}
+  "psaRange": "A String", # Optional. This field is not implemented. The values provided in this field are ignored.
+  "replicaZone": "A String", # Optional. Specifies the replica zone for regional storagePool.
+  "serviceLevel": "A String", # Required. Service level of the storage pool
+  "state": "A String", # Output only. State of the storage pool
+  "stateDetails": "A String", # Output only. State details of the storage pool
+  "volumeCapacityGib": "A String", # Output only. Allocated size of all volumes in GIB in the storage pool
+  "volumeCount": 42, # Output only. Volume count of the storage pool
+  "zone": "A String", # Optional. Specifies the active zone for regional storagePool.
+}
+
+  storagePoolId: string, Required. Id of the requesting storage pool. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Warning! This operation will permanently delete the storage pool.
+
+Args:
+  name: string, Required. Name of the storage pool (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Returns the description of the specified storage pool by poolId.
+
+Args:
+  name: string, Required. Name of the storage pool (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # StoragePool is a container for volumes with a service level and capacity. Volumes can be created in a pool of sufficient available capacity. StoragePool capacity is what you are billed for.
+  "activeDirectory": "A String", # Optional. Specifies the Active Directory to be used for creating a SMB volume.
+  "allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.
+  "capacityGib": "A String", # Required. Capacity in GIB of the pool
+  "createTime": "A String", # Output only. Create time of the storage pool
+  "description": "A String", # Optional. Description of the storage pool
+  "encryptionType": "A String", # Output only. Specifies the current pool encryption key source.
+  "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
+  "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "ldapEnabled": True or False, # Optional. Flag indicating if the pool is NFS LDAP enabled or not.
+  "name": "A String", # Identifier. Name of the storage pool
+  "network": "A String", # Required. VPC Network name. Format: projects/{project}/global/networks/{network}
+  "psaRange": "A String", # Optional. This field is not implemented. The values provided in this field are ignored.
+  "replicaZone": "A String", # Optional. Specifies the replica zone for regional storagePool.
+  "serviceLevel": "A String", # Required. Service level of the storage pool
+  "state": "A String", # Output only. State of the storage pool
+  "stateDetails": "A String", # Output only. State details of the storage pool
+  "volumeCapacityGib": "A String", # Output only. Allocated size of all volumes in GIB in the storage pool
+  "volumeCount": 42, # Output only. Volume count of the storage pool
+  "zone": "A String", # Optional. Specifies the active zone for regional storagePool.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns descriptions of all storage pools owned by the caller.
+
+Args:
+  parent: string, Required. Parent value (required)
+  filter: string, Optional. List filter.
+  orderBy: string, Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).
+  pageSize: integer, Optional. The maximum number of items to return.
+  pageToken: string, Optional. The next_page_token value to use if there are additional results to retrieve for this list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ListStoragePoolsResponse is the response to a ListStoragePoolsRequest.
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "storagePools": [ # The list of StoragePools
+    { # StoragePool is a container for volumes with a service level and capacity. Volumes can be created in a pool of sufficient available capacity. StoragePool capacity is what you are billed for.
+      "activeDirectory": "A String", # Optional. Specifies the Active Directory to be used for creating a SMB volume.
+      "allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.
+      "capacityGib": "A String", # Required. Capacity in GIB of the pool
+      "createTime": "A String", # Output only. Create time of the storage pool
+      "description": "A String", # Optional. Description of the storage pool
+      "encryptionType": "A String", # Output only. Specifies the current pool encryption key source.
+      "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
+      "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption.
+      "labels": { # Optional. Labels as key value pairs
+        "a_key": "A String",
+      },
+      "ldapEnabled": True or False, # Optional. Flag indicating if the pool is NFS LDAP enabled or not.
+      "name": "A String", # Identifier. Name of the storage pool
+      "network": "A String", # Required. VPC Network name. Format: projects/{project}/global/networks/{network}
+      "psaRange": "A String", # Optional. This field is not implemented. The values provided in this field are ignored.
+      "replicaZone": "A String", # Optional. Specifies the replica zone for regional storagePool.
+      "serviceLevel": "A String", # Required. Service level of the storage pool
+      "state": "A String", # Output only. State of the storage pool
+      "stateDetails": "A String", # Output only. State details of the storage pool
+      "volumeCapacityGib": "A String", # Output only. Allocated size of all volumes in GIB in the storage pool
+      "volumeCount": 42, # Output only. Volume count of the storage pool
+      "zone": "A String", # Optional. Specifies the active zone for regional storagePool.
+    },
+  ],
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the storage pool properties with the full spec
+
+Args:
+  name: string, Identifier. Name of the storage pool (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # StoragePool is a container for volumes with a service level and capacity. Volumes can be created in a pool of sufficient available capacity. StoragePool capacity is what you are billed for.
+  "activeDirectory": "A String", # Optional. Specifies the Active Directory to be used for creating a SMB volume.
+  "allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.
+  "capacityGib": "A String", # Required. Capacity in GIB of the pool
+  "createTime": "A String", # Output only. Create time of the storage pool
+  "description": "A String", # Optional. Description of the storage pool
+  "encryptionType": "A String", # Output only. Specifies the current pool encryption key source.
+  "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
+  "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "ldapEnabled": True or False, # Optional. Flag indicating if the pool is NFS LDAP enabled or not.
+  "name": "A String", # Identifier. Name of the storage pool
+  "network": "A String", # Required. VPC Network name. Format: projects/{project}/global/networks/{network}
+  "psaRange": "A String", # Optional. This field is not implemented. The values provided in this field are ignored.
+  "replicaZone": "A String", # Optional. Specifies the replica zone for regional storagePool.
+  "serviceLevel": "A String", # Required. Service level of the storage pool
+  "state": "A String", # Output only. State of the storage pool
+  "stateDetails": "A String", # Output only. State details of the storage pool
+  "volumeCapacityGib": "A String", # Output only. Allocated size of all volumes in GIB in the storage pool
+  "volumeCount": 42, # Output only. Volume count of the storage pool
+  "zone": "A String", # Optional. Specifies the active zone for regional storagePool.
+}
+
+  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the StoragePool resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ switch(name, body=None, x__xgafv=None) +
This operation will switch the active/replica zone for a regional storagePool.
+
+Args:
+  name: string, Required. Name of the storage pool (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # SwitchActiveReplicaZoneRequest switch the active/replica zone for a regional storagePool.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1beta1.projects.locations.volumes.html b/docs/dyn/netapp_v1beta1.projects.locations.volumes.html new file mode 100644 index 0000000000..066475a165 --- /dev/null +++ b/docs/dyn/netapp_v1beta1.projects.locations.volumes.html @@ -0,0 +1,757 @@ + + + +

NetApp API . projects . locations . volumes

+

Instance Methods

+

+ replications() +

+

Returns the replications Resource.

+ +

+ snapshots() +

+

Returns the snapshots Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new Volume in a given project and location.

+

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

+

Deletes a single Volume.

+

+ get(name, x__xgafv=None)

+

Gets details of a single Volume.

+

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

+

Lists Volumes in a given project.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the parameters of a single Volume.

+

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

+

Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, volumeId=None, x__xgafv=None) +
Creates a new Volume in a given project and location.
+
+Args:
+  parent: string, Required. Value for parent. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Volume provides a filesystem that you can mount.
+  "activeDirectory": "A String", # Output only. Specifies the ActiveDirectory name of a SMB volume.
+  "backupConfig": { # BackupConfig contains backup related config on a volume. # BackupConfig of the volume.
+    "backupChainBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).
+    "backupPolicies": [ # Optional. When specified, schedule backups will be created based on the policy configuration.
+      "A String",
+    ],
+    "backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
+    "scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
+  },
+  "capacityGib": "A String", # Required. Capacity in GIB of the volume
+  "coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data in GiB.
+  "createTime": "A String", # Output only. Create time of the volume
+  "description": "A String", # Optional. Description of the volume
+  "encryptionType": "A String", # Output only. Specified the current volume encryption key source.
+  "exportPolicy": { # Defines the export policy for the volume. # Optional. Export policy of the volume
+    "rules": [ # Required. List of export policy rules
+      { # An export policy rule describing various export options.
+        "accessType": "A String", # Access type (ReadWrite, ReadOnly, None)
+        "allowedClients": "A String", # Comma separated list of allowed clients IP addresses
+        "hasRootAccess": "A String", # Whether Unix root access will be granted.
+        "kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
+        "kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled.
+        "kerberos5iReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
+        "kerberos5iReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value be ignored if this is enabled.
+        "kerberos5pReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
+        "kerberos5pReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value be ignored if this is enabled.
+        "nfsv3": True or False, # NFS V3 protocol.
+        "nfsv4": True or False, # NFS V4 protocol.
+      },
+    ],
+  },
+  "hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship.
+  "kerberosEnabled": True or False, # Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
+  "kmsConfig": "A String", # Output only. Specifies the KMS config to be used for volume encryption.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
+  "ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not.
+  "mountOptions": [ # Output only. Mount options of this volume
+    { # View only mount options for a volume.
+      "export": "A String", # Export string
+      "exportFull": "A String", # Full export string
+      "instructions": "A String", # Instructions for mounting
+      "protocol": "A String", # Protocol to mount with.
+    },
+  ],
+  "multipleEndpoints": True or False, # Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.
+  "name": "A String", # Identifier. Name of the volume
+  "network": "A String", # Output only. VPC Network name. Format: projects/{project}/global/networks/{network}
+  "protocols": [ # Required. Protocols required for the volume
+    "A String",
+  ],
+  "psaRange": "A String", # Output only. This field is not implemented. The values provided in this field are ignored.
+  "replicaZone": "A String", # Output only. Specifies the replica zone for regional volume.
+  "restoreParameters": { # The RestoreParameters if volume is created from a snapshot or backup. # Optional. Specifies the source of the volume to be created from.
+    "sourceBackup": "A String", # Full name of the backup resource. Format: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}
+    "sourceSnapshot": "A String", # Full name of the snapshot resource. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}
+  },
+  "restrictedActions": [ # Optional. List of actions that are restricted on this volume.
+    "A String",
+  ],
+  "securityStyle": "A String", # Optional. Security Style of the Volume
+  "serviceLevel": "A String", # Output only. Service level of the volume
+  "shareName": "A String", # Required. Share name of the volume
+  "smbSettings": [ # Optional. SMB share settings for the volume.
+    "A String",
+  ],
+  "snapReserve": 3.14, # Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.
+  "snapshotDirectory": True or False, # Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.
+  "snapshotPolicy": { # Snapshot Policy for a volume. # Optional. SnapshotPolicy for a volume.
+    "dailySchedule": { # Make a snapshot every day e.g. at 04:00, 05:20, 23:50 # Daily schedule policy.
+      "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+    "enabled": True or False, # If enabled, make snapshots automatically according to the schedules. Default is false.
+    "hourlySchedule": { # Make a snapshot every hour e.g. at 04:00, 05:00, 06:00. # Hourly schedule policy.
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+    "monthlySchedule": { # Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50 # Monthly schedule policy.
+      "daysOfMonth": "A String", # Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
+      "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+    "weeklySchedule": { # Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50 # Weekly schedule policy.
+      "day": "A String", # Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
+      "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+  },
+  "state": "A String", # Output only. State of the volume
+  "stateDetails": "A String", # Output only. State details of the volume
+  "storagePool": "A String", # Required. StoragePool name of the volume
+  "tieringPolicy": { # Defines tiering policy for the volume. # Tiering policy for the volume.
+    "coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31.
+    "tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
+  },
+  "unixPermissions": "A String", # Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.
+  "usedGib": "A String", # Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.
+  "zone": "A String", # Output only. Specifies the active zone for regional volume.
+}
+
+  volumeId: string, Required. Id of the requesting volume. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, force=None, x__xgafv=None) +
Deletes a single Volume.
+
+Args:
+  name: string, Required. Name of the volume (required)
+  force: boolean, If this field is set as true, CCFE will not block the volume resource deletion even if it has any snapshots resource. (Otherwise, the request will only work if the volume has no snapshots.)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single Volume.
+
+Args:
+  name: string, Required. Name of the volume (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Volume provides a filesystem that you can mount.
+  "activeDirectory": "A String", # Output only. Specifies the ActiveDirectory name of a SMB volume.
+  "backupConfig": { # BackupConfig contains backup related config on a volume. # BackupConfig of the volume.
+    "backupChainBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).
+    "backupPolicies": [ # Optional. When specified, schedule backups will be created based on the policy configuration.
+      "A String",
+    ],
+    "backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
+    "scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
+  },
+  "capacityGib": "A String", # Required. Capacity in GIB of the volume
+  "coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data in GiB.
+  "createTime": "A String", # Output only. Create time of the volume
+  "description": "A String", # Optional. Description of the volume
+  "encryptionType": "A String", # Output only. Specified the current volume encryption key source.
+  "exportPolicy": { # Defines the export policy for the volume. # Optional. Export policy of the volume
+    "rules": [ # Required. List of export policy rules
+      { # An export policy rule describing various export options.
+        "accessType": "A String", # Access type (ReadWrite, ReadOnly, None)
+        "allowedClients": "A String", # Comma separated list of allowed clients IP addresses
+        "hasRootAccess": "A String", # Whether Unix root access will be granted.
+        "kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
+        "kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled.
+        "kerberos5iReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
+        "kerberos5iReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value be ignored if this is enabled.
+        "kerberos5pReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
+        "kerberos5pReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value be ignored if this is enabled.
+        "nfsv3": True or False, # NFS V3 protocol.
+        "nfsv4": True or False, # NFS V4 protocol.
+      },
+    ],
+  },
+  "hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship.
+  "kerberosEnabled": True or False, # Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
+  "kmsConfig": "A String", # Output only. Specifies the KMS config to be used for volume encryption.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
+  "ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not.
+  "mountOptions": [ # Output only. Mount options of this volume
+    { # View only mount options for a volume.
+      "export": "A String", # Export string
+      "exportFull": "A String", # Full export string
+      "instructions": "A String", # Instructions for mounting
+      "protocol": "A String", # Protocol to mount with.
+    },
+  ],
+  "multipleEndpoints": True or False, # Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.
+  "name": "A String", # Identifier. Name of the volume
+  "network": "A String", # Output only. VPC Network name. Format: projects/{project}/global/networks/{network}
+  "protocols": [ # Required. Protocols required for the volume
+    "A String",
+  ],
+  "psaRange": "A String", # Output only. This field is not implemented. The values provided in this field are ignored.
+  "replicaZone": "A String", # Output only. Specifies the replica zone for regional volume.
+  "restoreParameters": { # The RestoreParameters if volume is created from a snapshot or backup. # Optional. Specifies the source of the volume to be created from.
+    "sourceBackup": "A String", # Full name of the backup resource. Format: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}
+    "sourceSnapshot": "A String", # Full name of the snapshot resource. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}
+  },
+  "restrictedActions": [ # Optional. List of actions that are restricted on this volume.
+    "A String",
+  ],
+  "securityStyle": "A String", # Optional. Security Style of the Volume
+  "serviceLevel": "A String", # Output only. Service level of the volume
+  "shareName": "A String", # Required. Share name of the volume
+  "smbSettings": [ # Optional. SMB share settings for the volume.
+    "A String",
+  ],
+  "snapReserve": 3.14, # Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.
+  "snapshotDirectory": True or False, # Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.
+  "snapshotPolicy": { # Snapshot Policy for a volume. # Optional. SnapshotPolicy for a volume.
+    "dailySchedule": { # Make a snapshot every day e.g. at 04:00, 05:20, 23:50 # Daily schedule policy.
+      "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+    "enabled": True or False, # If enabled, make snapshots automatically according to the schedules. Default is false.
+    "hourlySchedule": { # Make a snapshot every hour e.g. at 04:00, 05:00, 06:00. # Hourly schedule policy.
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+    "monthlySchedule": { # Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50 # Monthly schedule policy.
+      "daysOfMonth": "A String", # Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
+      "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+    "weeklySchedule": { # Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50 # Weekly schedule policy.
+      "day": "A String", # Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
+      "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+  },
+  "state": "A String", # Output only. State of the volume
+  "stateDetails": "A String", # Output only. State details of the volume
+  "storagePool": "A String", # Required. StoragePool name of the volume
+  "tieringPolicy": { # Defines tiering policy for the volume. # Tiering policy for the volume.
+    "coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31.
+    "tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
+  },
+  "unixPermissions": "A String", # Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.
+  "usedGib": "A String", # Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.
+  "zone": "A String", # Output only. Specifies the active zone for regional volume.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Volumes in a given project.
+
+Args:
+  parent: string, Required. Parent value for ListVolumesRequest (required)
+  filter: string, Filtering results
+  orderBy: string, Hint for how to order the results
+  pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+  pageToken: string, A token identifying a page of results the server should return.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing Volumes
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+  "volumes": [ # The list of Volume
+    { # Volume provides a filesystem that you can mount.
+      "activeDirectory": "A String", # Output only. Specifies the ActiveDirectory name of a SMB volume.
+      "backupConfig": { # BackupConfig contains backup related config on a volume. # BackupConfig of the volume.
+        "backupChainBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).
+        "backupPolicies": [ # Optional. When specified, schedule backups will be created based on the policy configuration.
+          "A String",
+        ],
+        "backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
+        "scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
+      },
+      "capacityGib": "A String", # Required. Capacity in GIB of the volume
+      "coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data in GiB.
+      "createTime": "A String", # Output only. Create time of the volume
+      "description": "A String", # Optional. Description of the volume
+      "encryptionType": "A String", # Output only. Specified the current volume encryption key source.
+      "exportPolicy": { # Defines the export policy for the volume. # Optional. Export policy of the volume
+        "rules": [ # Required. List of export policy rules
+          { # An export policy rule describing various export options.
+            "accessType": "A String", # Access type (ReadWrite, ReadOnly, None)
+            "allowedClients": "A String", # Comma separated list of allowed clients IP addresses
+            "hasRootAccess": "A String", # Whether Unix root access will be granted.
+            "kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
+            "kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled.
+            "kerberos5iReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
+            "kerberos5iReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value be ignored if this is enabled.
+            "kerberos5pReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
+            "kerberos5pReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value be ignored if this is enabled.
+            "nfsv3": True or False, # NFS V3 protocol.
+            "nfsv4": True or False, # NFS V4 protocol.
+          },
+        ],
+      },
+      "hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship.
+      "kerberosEnabled": True or False, # Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
+      "kmsConfig": "A String", # Output only. Specifies the KMS config to be used for volume encryption.
+      "labels": { # Optional. Labels as key value pairs
+        "a_key": "A String",
+      },
+      "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
+      "ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not.
+      "mountOptions": [ # Output only. Mount options of this volume
+        { # View only mount options for a volume.
+          "export": "A String", # Export string
+          "exportFull": "A String", # Full export string
+          "instructions": "A String", # Instructions for mounting
+          "protocol": "A String", # Protocol to mount with.
+        },
+      ],
+      "multipleEndpoints": True or False, # Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.
+      "name": "A String", # Identifier. Name of the volume
+      "network": "A String", # Output only. VPC Network name. Format: projects/{project}/global/networks/{network}
+      "protocols": [ # Required. Protocols required for the volume
+        "A String",
+      ],
+      "psaRange": "A String", # Output only. This field is not implemented. The values provided in this field are ignored.
+      "replicaZone": "A String", # Output only. Specifies the replica zone for regional volume.
+      "restoreParameters": { # The RestoreParameters if volume is created from a snapshot or backup. # Optional. Specifies the source of the volume to be created from.
+        "sourceBackup": "A String", # Full name of the backup resource. Format: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}
+        "sourceSnapshot": "A String", # Full name of the snapshot resource. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}
+      },
+      "restrictedActions": [ # Optional. List of actions that are restricted on this volume.
+        "A String",
+      ],
+      "securityStyle": "A String", # Optional. Security Style of the Volume
+      "serviceLevel": "A String", # Output only. Service level of the volume
+      "shareName": "A String", # Required. Share name of the volume
+      "smbSettings": [ # Optional. SMB share settings for the volume.
+        "A String",
+      ],
+      "snapReserve": 3.14, # Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.
+      "snapshotDirectory": True or False, # Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.
+      "snapshotPolicy": { # Snapshot Policy for a volume. # Optional. SnapshotPolicy for a volume.
+        "dailySchedule": { # Make a snapshot every day e.g. at 04:00, 05:20, 23:50 # Daily schedule policy.
+          "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+          "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+          "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+        },
+        "enabled": True or False, # If enabled, make snapshots automatically according to the schedules. Default is false.
+        "hourlySchedule": { # Make a snapshot every hour e.g. at 04:00, 05:00, 06:00. # Hourly schedule policy.
+          "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+          "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+        },
+        "monthlySchedule": { # Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50 # Monthly schedule policy.
+          "daysOfMonth": "A String", # Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
+          "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+          "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+          "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+        },
+        "weeklySchedule": { # Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50 # Weekly schedule policy.
+          "day": "A String", # Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
+          "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+          "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+          "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+        },
+      },
+      "state": "A String", # Output only. State of the volume
+      "stateDetails": "A String", # Output only. State details of the volume
+      "storagePool": "A String", # Required. StoragePool name of the volume
+      "tieringPolicy": { # Defines tiering policy for the volume. # Tiering policy for the volume.
+        "coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31.
+        "tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
+      },
+      "unixPermissions": "A String", # Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.
+      "usedGib": "A String", # Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.
+      "zone": "A String", # Output only. Specifies the active zone for regional volume.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the parameters of a single Volume.
+
+Args:
+  name: string, Identifier. Name of the volume (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Volume provides a filesystem that you can mount.
+  "activeDirectory": "A String", # Output only. Specifies the ActiveDirectory name of a SMB volume.
+  "backupConfig": { # BackupConfig contains backup related config on a volume. # BackupConfig of the volume.
+    "backupChainBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).
+    "backupPolicies": [ # Optional. When specified, schedule backups will be created based on the policy configuration.
+      "A String",
+    ],
+    "backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
+    "scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
+  },
+  "capacityGib": "A String", # Required. Capacity in GIB of the volume
+  "coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data in GiB.
+  "createTime": "A String", # Output only. Create time of the volume
+  "description": "A String", # Optional. Description of the volume
+  "encryptionType": "A String", # Output only. Specified the current volume encryption key source.
+  "exportPolicy": { # Defines the export policy for the volume. # Optional. Export policy of the volume
+    "rules": [ # Required. List of export policy rules
+      { # An export policy rule describing various export options.
+        "accessType": "A String", # Access type (ReadWrite, ReadOnly, None)
+        "allowedClients": "A String", # Comma separated list of allowed clients IP addresses
+        "hasRootAccess": "A String", # Whether Unix root access will be granted.
+        "kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
+        "kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled.
+        "kerberos5iReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
+        "kerberos5iReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value be ignored if this is enabled.
+        "kerberos5pReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
+        "kerberos5pReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value be ignored if this is enabled.
+        "nfsv3": True or False, # NFS V3 protocol.
+        "nfsv4": True or False, # NFS V4 protocol.
+      },
+    ],
+  },
+  "hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship.
+  "kerberosEnabled": True or False, # Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
+  "kmsConfig": "A String", # Output only. Specifies the KMS config to be used for volume encryption.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
+  "ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not.
+  "mountOptions": [ # Output only. Mount options of this volume
+    { # View only mount options for a volume.
+      "export": "A String", # Export string
+      "exportFull": "A String", # Full export string
+      "instructions": "A String", # Instructions for mounting
+      "protocol": "A String", # Protocol to mount with.
+    },
+  ],
+  "multipleEndpoints": True or False, # Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.
+  "name": "A String", # Identifier. Name of the volume
+  "network": "A String", # Output only. VPC Network name. Format: projects/{project}/global/networks/{network}
+  "protocols": [ # Required. Protocols required for the volume
+    "A String",
+  ],
+  "psaRange": "A String", # Output only. This field is not implemented. The values provided in this field are ignored.
+  "replicaZone": "A String", # Output only. Specifies the replica zone for regional volume.
+  "restoreParameters": { # The RestoreParameters if volume is created from a snapshot or backup. # Optional. Specifies the source of the volume to be created from.
+    "sourceBackup": "A String", # Full name of the backup resource. Format: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}
+    "sourceSnapshot": "A String", # Full name of the snapshot resource. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}
+  },
+  "restrictedActions": [ # Optional. List of actions that are restricted on this volume.
+    "A String",
+  ],
+  "securityStyle": "A String", # Optional. Security Style of the Volume
+  "serviceLevel": "A String", # Output only. Service level of the volume
+  "shareName": "A String", # Required. Share name of the volume
+  "smbSettings": [ # Optional. SMB share settings for the volume.
+    "A String",
+  ],
+  "snapReserve": 3.14, # Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.
+  "snapshotDirectory": True or False, # Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.
+  "snapshotPolicy": { # Snapshot Policy for a volume. # Optional. SnapshotPolicy for a volume.
+    "dailySchedule": { # Make a snapshot every day e.g. at 04:00, 05:20, 23:50 # Daily schedule policy.
+      "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+    "enabled": True or False, # If enabled, make snapshots automatically according to the schedules. Default is false.
+    "hourlySchedule": { # Make a snapshot every hour e.g. at 04:00, 05:00, 06:00. # Hourly schedule policy.
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+    "monthlySchedule": { # Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50 # Monthly schedule policy.
+      "daysOfMonth": "A String", # Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
+      "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+    "weeklySchedule": { # Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50 # Weekly schedule policy.
+      "day": "A String", # Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
+      "hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
+      "minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
+      "snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
+    },
+  },
+  "state": "A String", # Output only. State of the volume
+  "stateDetails": "A String", # Output only. State details of the volume
+  "storagePool": "A String", # Required. StoragePool name of the volume
+  "tieringPolicy": { # Defines tiering policy for the volume. # Tiering policy for the volume.
+    "coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31.
+    "tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
+  },
+  "unixPermissions": "A String", # Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.
+  "usedGib": "A String", # Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.
+  "zone": "A String", # Output only. Specifies the active zone for regional volume.
+}
+
+  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Volume resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ revert(name, body=None, x__xgafv=None) +
Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created.
+
+Args:
+  name: string, Required. The resource name of the volume, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # RevertVolumeRequest reverts the given volume to the specified snapshot.
+  "snapshotId": "A String", # Required. The snapshot resource ID, in the format 'my-snapshot', where the specified ID is the {snapshot_id} of the fully qualified name like projects/{project_id}/locations/{location_id}/volumes/{volume_id}/snapshots/{snapshot_id}
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1beta1.projects.locations.volumes.replications.html b/docs/dyn/netapp_v1beta1.projects.locations.volumes.replications.html new file mode 100644 index 0000000000..1fe2fb0386 --- /dev/null +++ b/docs/dyn/netapp_v1beta1.projects.locations.volumes.replications.html @@ -0,0 +1,538 @@ + + + +

NetApp API . projects . locations . volumes . replications

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Create a new replication for a volume.

+

+ delete(name, x__xgafv=None)

+

Deletes a replication.

+

+ get(name, x__xgafv=None)

+

Describe a replication for a volume.

+

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

+

Returns descriptions of all replications for a volume.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the settings of a specific replication.

+

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

+

Resume Cross Region Replication.

+

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

+

Reverses direction of replication. Source becomes destination and destination becomes source.

+

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

+

Stop Cross Region Replication.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, replicationId=None, x__xgafv=None) +
Create a new replication for a volume.
+
+Args:
+  parent: string, Required. The NetApp volume to create the replications of, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.
+  "createTime": "A String", # Output only. Replication create time.
+  "description": "A String", # A description about this replication relationship.
+  "destinationVolume": "A String", # Output only. Full name of destination volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
+  "destinationVolumeParameters": { # DestinationVolumeParameters specify input parameters used for creating destination volume. # Required. Input only. Destination volume parameters
+    "description": "A String", # Description for the destination volume.
+    "shareName": "A String", # Destination volume's share name. If not specified, source volume's share name will be used.
+    "storagePool": "A String", # Required. Existing destination StoragePool name.
+    "volumeId": "A String", # Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
+  },
+  "healthy": True or False, # Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "mirrorState": "A String", # Output only. Indicates the state of mirroring.
+  "name": "A String", # Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
+  "replicationSchedule": "A String", # Required. Indicates the schedule for replication.
+  "role": "A String", # Output only. Indicates whether this points to source or destination.
+  "sourceVolume": "A String", # Output only. Full name of source volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
+  "state": "A String", # Output only. State of the replication.
+  "stateDetails": "A String", # Output only. State details of the replication.
+  "transferStats": { # TransferStats reports all statistics related to replication transfer. # Output only. Replication transfer statistics.
+    "lagDuration": "A String", # Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.
+    "lastTransferBytes": "A String", # Last transfer size in bytes.
+    "lastTransferDuration": "A String", # Time taken during last transfer.
+    "lastTransferEndTime": "A String", # Time when last transfer completed.
+    "lastTransferError": "A String", # A message describing the cause of the last transfer failure.
+    "totalTransferDuration": "A String", # Cumulative time taken across all transfers for the replication relationship.
+    "transferBytes": "A String", # Cumulative bytes trasferred so far for the replication relatinonship.
+    "updateTime": "A String", # Time when progress was updated last.
+  },
+}
+
+  replicationId: string, Required. ID of the replication to create. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a replication.
+
+Args:
+  name: string, Required. The replication resource name, in the format `projects/*/locations/*/volumes/*/replications/{replication_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Describe a replication for a volume.
+
+Args:
+  name: string, Required. The replication resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.
+  "createTime": "A String", # Output only. Replication create time.
+  "description": "A String", # A description about this replication relationship.
+  "destinationVolume": "A String", # Output only. Full name of destination volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
+  "destinationVolumeParameters": { # DestinationVolumeParameters specify input parameters used for creating destination volume. # Required. Input only. Destination volume parameters
+    "description": "A String", # Description for the destination volume.
+    "shareName": "A String", # Destination volume's share name. If not specified, source volume's share name will be used.
+    "storagePool": "A String", # Required. Existing destination StoragePool name.
+    "volumeId": "A String", # Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
+  },
+  "healthy": True or False, # Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "mirrorState": "A String", # Output only. Indicates the state of mirroring.
+  "name": "A String", # Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
+  "replicationSchedule": "A String", # Required. Indicates the schedule for replication.
+  "role": "A String", # Output only. Indicates whether this points to source or destination.
+  "sourceVolume": "A String", # Output only. Full name of source volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
+  "state": "A String", # Output only. State of the replication.
+  "stateDetails": "A String", # Output only. State details of the replication.
+  "transferStats": { # TransferStats reports all statistics related to replication transfer. # Output only. Replication transfer statistics.
+    "lagDuration": "A String", # Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.
+    "lastTransferBytes": "A String", # Last transfer size in bytes.
+    "lastTransferDuration": "A String", # Time taken during last transfer.
+    "lastTransferEndTime": "A String", # Time when last transfer completed.
+    "lastTransferError": "A String", # A message describing the cause of the last transfer failure.
+    "totalTransferDuration": "A String", # Cumulative time taken across all transfers for the replication relationship.
+    "transferBytes": "A String", # Cumulative bytes trasferred so far for the replication relatinonship.
+    "updateTime": "A String", # Time when progress was updated last.
+  },
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns descriptions of all replications for a volume.
+
+Args:
+  parent: string, Required. The volume for which to retrieve replication information, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`. (required)
+  filter: string, List filter.
+  orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
+  pageSize: integer, The maximum number of items to return.
+  pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ListReplicationsResponse is the result of ListReplicationsRequest.
+  "nextPageToken": "A String", # The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
+  "replications": [ # A list of replications in the project for the specified volume.
+    { # Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.
+      "createTime": "A String", # Output only. Replication create time.
+      "description": "A String", # A description about this replication relationship.
+      "destinationVolume": "A String", # Output only. Full name of destination volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
+      "destinationVolumeParameters": { # DestinationVolumeParameters specify input parameters used for creating destination volume. # Required. Input only. Destination volume parameters
+        "description": "A String", # Description for the destination volume.
+        "shareName": "A String", # Destination volume's share name. If not specified, source volume's share name will be used.
+        "storagePool": "A String", # Required. Existing destination StoragePool name.
+        "volumeId": "A String", # Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
+      },
+      "healthy": True or False, # Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
+      "labels": { # Resource labels to represent user provided metadata.
+        "a_key": "A String",
+      },
+      "mirrorState": "A String", # Output only. Indicates the state of mirroring.
+      "name": "A String", # Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
+      "replicationSchedule": "A String", # Required. Indicates the schedule for replication.
+      "role": "A String", # Output only. Indicates whether this points to source or destination.
+      "sourceVolume": "A String", # Output only. Full name of source volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
+      "state": "A String", # Output only. State of the replication.
+      "stateDetails": "A String", # Output only. State details of the replication.
+      "transferStats": { # TransferStats reports all statistics related to replication transfer. # Output only. Replication transfer statistics.
+        "lagDuration": "A String", # Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.
+        "lastTransferBytes": "A String", # Last transfer size in bytes.
+        "lastTransferDuration": "A String", # Time taken during last transfer.
+        "lastTransferEndTime": "A String", # Time when last transfer completed.
+        "lastTransferError": "A String", # A message describing the cause of the last transfer failure.
+        "totalTransferDuration": "A String", # Cumulative time taken across all transfers for the replication relationship.
+        "transferBytes": "A String", # Cumulative bytes trasferred so far for the replication relatinonship.
+        "updateTime": "A String", # Time when progress was updated last.
+      },
+    },
+  ],
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the settings of a specific replication.
+
+Args:
+  name: string, Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.
+  "createTime": "A String", # Output only. Replication create time.
+  "description": "A String", # A description about this replication relationship.
+  "destinationVolume": "A String", # Output only. Full name of destination volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
+  "destinationVolumeParameters": { # DestinationVolumeParameters specify input parameters used for creating destination volume. # Required. Input only. Destination volume parameters
+    "description": "A String", # Description for the destination volume.
+    "shareName": "A String", # Destination volume's share name. If not specified, source volume's share name will be used.
+    "storagePool": "A String", # Required. Existing destination StoragePool name.
+    "volumeId": "A String", # Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
+  },
+  "healthy": True or False, # Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "mirrorState": "A String", # Output only. Indicates the state of mirroring.
+  "name": "A String", # Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
+  "replicationSchedule": "A String", # Required. Indicates the schedule for replication.
+  "role": "A String", # Output only. Indicates whether this points to source or destination.
+  "sourceVolume": "A String", # Output only. Full name of source volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
+  "state": "A String", # Output only. State of the replication.
+  "stateDetails": "A String", # Output only. State details of the replication.
+  "transferStats": { # TransferStats reports all statistics related to replication transfer. # Output only. Replication transfer statistics.
+    "lagDuration": "A String", # Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.
+    "lastTransferBytes": "A String", # Last transfer size in bytes.
+    "lastTransferDuration": "A String", # Time taken during last transfer.
+    "lastTransferEndTime": "A String", # Time when last transfer completed.
+    "lastTransferError": "A String", # A message describing the cause of the last transfer failure.
+    "totalTransferDuration": "A String", # Cumulative time taken across all transfers for the replication relationship.
+    "transferBytes": "A String", # Cumulative bytes trasferred so far for the replication relatinonship.
+    "updateTime": "A String", # Time when progress was updated last.
+  },
+}
+
+  updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ resume(name, body=None, x__xgafv=None) +
Resume Cross Region Replication.
+
+Args:
+  name: string, Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # ResumeReplicationRequest resumes a stopped replication.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ reverseDirection(name, body=None, x__xgafv=None) +
Reverses direction of replication. Source becomes destination and destination becomes source.
+
+Args:
+  name: string, Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # ReverseReplicationDirectionRequest reverses direction of replication. Source becomes destination and destination becomes source.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ stop(name, body=None, x__xgafv=None) +
Stop Cross Region Replication.
+
+Args:
+  name: string, Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # StopReplicationRequest stops a replication until resumed.
+  "force": True or False, # Indicates whether to stop replication forcefully while data transfer is in progress. Warning! if force is true, this will abort any current transfers and can lead to data loss due to partial transfer. If force is false, stop replication will fail while data transfer is in progress and you will need to retry later.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/netapp_v1beta1.projects.locations.volumes.snapshots.html b/docs/dyn/netapp_v1beta1.projects.locations.volumes.snapshots.html new file mode 100644 index 0000000000..2536feddc6 --- /dev/null +++ b/docs/dyn/netapp_v1beta1.projects.locations.volumes.snapshots.html @@ -0,0 +1,321 @@ + + + +

NetApp API . projects . locations . volumes . snapshots

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Create a new snapshot for a volume.

+

+ delete(name, x__xgafv=None)

+

Deletes a snapshot.

+

+ get(name, x__xgafv=None)

+

Describe a snapshot for a volume.

+

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

+

Returns descriptions of all snapshots for a volume.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the settings of a specific snapshot.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, snapshotId=None, x__xgafv=None) +
Create a new snapshot for a volume.
+
+Args:
+  parent: string, Required. The NetApp volume to create the snapshots of, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Snapshot is a point-in-time version of a Volume's content.
+  "createTime": "A String", # Output only. The time when the snapshot was created.
+  "description": "A String", # A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the snapshot. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`.
+  "state": "A String", # Output only. The snapshot state.
+  "stateDetails": "A String", # Output only. State details of the storage pool
+  "usedBytes": 3.14, # Output only. Current storage usage for the snapshot in bytes.
+}
+
+  snapshotId: string, Required. ID of the snapshot to create. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a snapshot.
+
+Args:
+  name: string, Required. The snapshot resource name, in the format `projects/*/locations/*/volumes/*/snapshots/{snapshot_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Describe a snapshot for a volume.
+
+Args:
+  name: string, Required. The snapshot resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Snapshot is a point-in-time version of a Volume's content.
+  "createTime": "A String", # Output only. The time when the snapshot was created.
+  "description": "A String", # A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the snapshot. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`.
+  "state": "A String", # Output only. The snapshot state.
+  "stateDetails": "A String", # Output only. State details of the storage pool
+  "usedBytes": 3.14, # Output only. Current storage usage for the snapshot in bytes.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns descriptions of all snapshots for a volume.
+
+Args:
+  parent: string, Required. The volume for which to retrieve snapshot information, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`. (required)
+  filter: string, List filter.
+  orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
+  pageSize: integer, The maximum number of items to return.
+  pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ListSnapshotsResponse is the result of ListSnapshotsRequest.
+  "nextPageToken": "A String", # The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
+  "snapshots": [ # A list of snapshots in the project for the specified volume.
+    { # Snapshot is a point-in-time version of a Volume's content.
+      "createTime": "A String", # Output only. The time when the snapshot was created.
+      "description": "A String", # A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.
+      "labels": { # Resource labels to represent user provided metadata.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name of the snapshot. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`.
+      "state": "A String", # Output only. The snapshot state.
+      "stateDetails": "A String", # Output only. State details of the storage pool
+      "usedBytes": 3.14, # Output only. Current storage usage for the snapshot in bytes.
+    },
+  ],
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the settings of a specific snapshot.
+
+Args:
+  name: string, Identifier. The resource name of the snapshot. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Snapshot is a point-in-time version of a Volume's content.
+  "createTime": "A String", # Output only. The time when the snapshot was created.
+  "description": "A String", # A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.
+  "labels": { # Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the snapshot. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`.
+  "state": "A String", # Output only. The snapshot state.
+  "stateDetails": "A String", # Output only. State details of the storage pool
+  "usedBytes": 3.14, # Output only. Current storage usage for the snapshot in bytes.
+}
+
+  updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.internalRanges.html b/docs/dyn/networkconnectivity_v1.projects.locations.internalRanges.html index 9fbed30832..586d2e59e5 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. Should be present if usage is set to FOR_MIGRATION. + "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. "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. Should be present if usage is set to FOR_MIGRATION. + "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. "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. Should be present if usage is set to FOR_MIGRATION. + "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. "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. Should be present if usage is set to FOR_MIGRATION. + "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. "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.serviceConnectionMaps.html b/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionMaps.html index a028652bdc..9c18e68968 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionMaps.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionMaps.html @@ -124,6 +124,7 @@

Method Details

{ # Allow the producer to specify which consumers can connect to it. "consumerInstanceProject": "A String", # Required. The project ID or project number of the consumer project. This project is the one that the consumer uses to interact with the producer instance. From the perspective of a consumer who's created a producer instance, this is the project of the producer instance. Format: 'projects/' Eg. 'projects/consumer-project' or 'projects/1234' "disableGlobalAccess": True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. + "ipVersion": "A String", # The requested IP version for the PSC connection. "network": "A String", # The resource path of the consumer network where PSC connections are allowed to be created in. Note, this network does not need be in the ConsumerPscConfig.project in the case of SharedVPC. Example: projects/{projectNumOrId}/global/networks/{networkId}. "producerInstanceId": "A String", # Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance. "producerInstanceMetadata": { # Immutable. An immutable map for the producer instance metadata. @@ -158,6 +159,7 @@

Method Details

"forwardingRule": "A String", # The URI of the consumer forwarding rule created. Example: projects/{projectNumOrId}/regions/us-east1/networks/{resourceId}. "gceOperation": "A String", # The last Compute Engine operation to setup PSC connection. "ip": "A String", # The IP literal allocated on the consumer network for the PSC forwarding rule that is created to connect to the producer service attachment in this service connection map. + "ipVersion": "A String", # The requested IP version for the PSC connection. "network": "A String", # The consumer network whose PSC forwarding rule is connected to the service attachments in this service connection map. Note that the network could be on a different project (shared VPC). "producerInstanceId": "A String", # Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance. "producerInstanceMetadata": { # Immutable. An immutable map for the producer instance metadata. @@ -276,6 +278,7 @@

Method Details

{ # Allow the producer to specify which consumers can connect to it. "consumerInstanceProject": "A String", # Required. The project ID or project number of the consumer project. This project is the one that the consumer uses to interact with the producer instance. From the perspective of a consumer who's created a producer instance, this is the project of the producer instance. Format: 'projects/' Eg. 'projects/consumer-project' or 'projects/1234' "disableGlobalAccess": True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. + "ipVersion": "A String", # The requested IP version for the PSC connection. "network": "A String", # The resource path of the consumer network where PSC connections are allowed to be created in. Note, this network does not need be in the ConsumerPscConfig.project in the case of SharedVPC. Example: projects/{projectNumOrId}/global/networks/{networkId}. "producerInstanceId": "A String", # Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance. "producerInstanceMetadata": { # Immutable. An immutable map for the producer instance metadata. @@ -310,6 +313,7 @@

Method Details

"forwardingRule": "A String", # The URI of the consumer forwarding rule created. Example: projects/{projectNumOrId}/regions/us-east1/networks/{resourceId}. "gceOperation": "A String", # The last Compute Engine operation to setup PSC connection. "ip": "A String", # The IP literal allocated on the consumer network for the PSC forwarding rule that is created to connect to the producer service attachment in this service connection map. + "ipVersion": "A String", # The requested IP version for the PSC connection. "network": "A String", # The consumer network whose PSC forwarding rule is connected to the service attachments in this service connection map. Note that the network could be on a different project (shared VPC). "producerInstanceId": "A String", # Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance. "producerInstanceMetadata": { # Immutable. An immutable map for the producer instance metadata. @@ -416,6 +420,7 @@

Method Details

{ # Allow the producer to specify which consumers can connect to it. "consumerInstanceProject": "A String", # Required. The project ID or project number of the consumer project. This project is the one that the consumer uses to interact with the producer instance. From the perspective of a consumer who's created a producer instance, this is the project of the producer instance. Format: 'projects/' Eg. 'projects/consumer-project' or 'projects/1234' "disableGlobalAccess": True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. + "ipVersion": "A String", # The requested IP version for the PSC connection. "network": "A String", # The resource path of the consumer network where PSC connections are allowed to be created in. Note, this network does not need be in the ConsumerPscConfig.project in the case of SharedVPC. Example: projects/{projectNumOrId}/global/networks/{networkId}. "producerInstanceId": "A String", # Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance. "producerInstanceMetadata": { # Immutable. An immutable map for the producer instance metadata. @@ -450,6 +455,7 @@

Method Details

"forwardingRule": "A String", # The URI of the consumer forwarding rule created. Example: projects/{projectNumOrId}/regions/us-east1/networks/{resourceId}. "gceOperation": "A String", # The last Compute Engine operation to setup PSC connection. "ip": "A String", # The IP literal allocated on the consumer network for the PSC forwarding rule that is created to connect to the producer service attachment in this service connection map. + "ipVersion": "A String", # The requested IP version for the PSC connection. "network": "A String", # The consumer network whose PSC forwarding rule is connected to the service attachments in this service connection map. Note that the network could be on a different project (shared VPC). "producerInstanceId": "A String", # Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance. "producerInstanceMetadata": { # Immutable. An immutable map for the producer instance metadata. @@ -515,6 +521,7 @@

Method Details

{ # Allow the producer to specify which consumers can connect to it. "consumerInstanceProject": "A String", # Required. The project ID or project number of the consumer project. This project is the one that the consumer uses to interact with the producer instance. From the perspective of a consumer who's created a producer instance, this is the project of the producer instance. Format: 'projects/' Eg. 'projects/consumer-project' or 'projects/1234' "disableGlobalAccess": True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. + "ipVersion": "A String", # The requested IP version for the PSC connection. "network": "A String", # The resource path of the consumer network where PSC connections are allowed to be created in. Note, this network does not need be in the ConsumerPscConfig.project in the case of SharedVPC. Example: projects/{projectNumOrId}/global/networks/{networkId}. "producerInstanceId": "A String", # Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance. "producerInstanceMetadata": { # Immutable. An immutable map for the producer instance metadata. @@ -549,6 +556,7 @@

Method Details

"forwardingRule": "A String", # The URI of the consumer forwarding rule created. Example: projects/{projectNumOrId}/regions/us-east1/networks/{resourceId}. "gceOperation": "A String", # The last Compute Engine operation to setup PSC connection. "ip": "A String", # The IP literal allocated on the consumer network for the PSC forwarding rule that is created to connect to the producer service attachment in this service connection map. + "ipVersion": "A String", # The requested IP version for the PSC connection. "network": "A String", # The consumer network whose PSC forwarding rule is connected to the service attachments in this service connection map. Note that the network could be on a different project (shared VPC). "producerInstanceId": "A String", # Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance. "producerInstanceMetadata": { # Immutable. An immutable map for the producer instance metadata. diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionPolicies.html b/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionPolicies.html index adea16c838..143ce3ab16 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionPolicies.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionPolicies.html @@ -162,6 +162,7 @@

Method Details

}, "errorType": "A String", # The error type indicates whether the error is consumer facing, producer facing or system internal. "gceOperation": "A String", # The last Compute Engine operation to setup PSC connection. + "ipVersion": "A String", # The requested IP version for the PSC connection. "producerInstanceId": "A String", # Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance. "producerInstanceMetadata": { # Immutable. An immutable map for the producer instance metadata. "a_key": "A String", @@ -301,6 +302,7 @@

Method Details

}, "errorType": "A String", # The error type indicates whether the error is consumer facing, producer facing or system internal. "gceOperation": "A String", # The last Compute Engine operation to setup PSC connection. + "ipVersion": "A String", # The requested IP version for the PSC connection. "producerInstanceId": "A String", # Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance. "producerInstanceMetadata": { # Immutable. An immutable map for the producer instance metadata. "a_key": "A String", @@ -428,6 +430,7 @@

Method Details

}, "errorType": "A String", # The error type indicates whether the error is consumer facing, producer facing or system internal. "gceOperation": "A String", # The last Compute Engine operation to setup PSC connection. + "ipVersion": "A String", # The requested IP version for the PSC connection. "producerInstanceId": "A String", # Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance. "producerInstanceMetadata": { # Immutable. An immutable map for the producer instance metadata. "a_key": "A String", @@ -514,6 +517,7 @@

Method Details

}, "errorType": "A String", # The error type indicates whether the error is consumer facing, producer facing or system internal. "gceOperation": "A String", # The last Compute Engine operation to setup PSC connection. + "ipVersion": "A String", # The requested IP version for the PSC connection. "producerInstanceId": "A String", # Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance. "producerInstanceMetadata": { # Immutable. An immutable map for the producer instance metadata. "a_key": "A String", diff --git a/docs/dyn/networkconnectivity_v1alpha1.projects.locations.internalRanges.html b/docs/dyn/networkconnectivity_v1alpha1.projects.locations.internalRanges.html index da87f2f768..60d905be61 100644 --- a/docs/dyn/networkconnectivity_v1alpha1.projects.locations.internalRanges.html +++ b/docs/dyn/networkconnectivity_v1alpha1.projects.locations.internalRanges.html @@ -126,7 +126,7 @@

Method Details

"labels": { # User-defined labels. "a_key": "A String", }, - "migration": { # Specification for migration with source and target resource names. # Optional. Should be present if usage is set to FOR_MIGRATION. + "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. "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} }, @@ -235,7 +235,7 @@

Method Details

"labels": { # User-defined labels. "a_key": "A String", }, - "migration": { # Specification for migration with source and target resource names. # Optional. Should be present if usage is set to FOR_MIGRATION. + "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. "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} }, @@ -332,7 +332,7 @@

Method Details

"labels": { # User-defined labels. "a_key": "A String", }, - "migration": { # Specification for migration with source and target resource names. # Optional. Should be present if usage is set to FOR_MIGRATION. + "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. "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} }, @@ -390,7 +390,7 @@

Method Details

"labels": { # User-defined labels. "a_key": "A String", }, - "migration": { # Specification for migration with source and target resource names. # Optional. Should be present if usage is set to FOR_MIGRATION. + "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. "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 7428a2f5b0..c3cb66184e 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html @@ -244,7 +244,6 @@

Method Details

"cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. - "serviceName": "A String", # ID of Cloud Run Service this revision belongs to. Was never set, is not exported to v1 proto and public protos. Do not export to v1beta1 public proto. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. "uri": "A String", # URI of a Cloud Run revision. }, @@ -720,7 +719,6 @@

Method Details

"cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. - "serviceName": "A String", # ID of Cloud Run Service this revision belongs to. Was never set, is not exported to v1 proto and public protos. Do not export to v1beta1 public proto. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. "uri": "A String", # URI of a Cloud Run revision. }, @@ -1187,7 +1185,6 @@

Method Details

"cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. - "serviceName": "A String", # ID of Cloud Run Service this revision belongs to. Was never set, is not exported to v1 proto and public protos. Do not export to v1beta1 public proto. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. "uri": "A String", # URI of a Cloud Run revision. }, @@ -1613,7 +1610,6 @@

Method Details

"cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. - "serviceName": "A String", # ID of Cloud Run Service this revision belongs to. Was never set, is not exported to v1 proto and public protos. Do not export to v1beta1 public proto. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. "uri": "A String", # URI of a Cloud Run revision. }, diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.vpcFlowLogsConfigs.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.vpcFlowLogsConfigs.html index 8a20f8f6f5..ba367482f2 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.vpcFlowLogsConfigs.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.vpcFlowLogsConfigs.html @@ -126,6 +126,7 @@

Method Details

], "name": "A String", # Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` "state": "A String", # Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. + "targetResourceState": "A String", # Output only. A diagnostic bit - describes the state of the configured target resource for diagnostic purposes. "updateTime": "A String", # Output only. The time the config was updated. "vpnTunnel": "A String", # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name} } @@ -225,6 +226,7 @@

Method Details

], "name": "A String", # Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` "state": "A String", # Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. + "targetResourceState": "A String", # Output only. A diagnostic bit - describes the state of the configured target resource for diagnostic purposes. "updateTime": "A String", # Output only. The time the config was updated. "vpnTunnel": "A String", # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name} }
@@ -270,6 +272,7 @@

Method Details

], "name": "A String", # Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` "state": "A String", # Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. + "targetResourceState": "A String", # Output only. A diagnostic bit - describes the state of the configured target resource for diagnostic purposes. "updateTime": "A String", # Output only. The time the config was updated. "vpnTunnel": "A String", # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name} }, @@ -316,6 +319,7 @@

Method Details

], "name": "A String", # Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` "state": "A String", # Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. + "targetResourceState": "A String", # Output only. A diagnostic bit - describes the state of the configured target resource for diagnostic purposes. "updateTime": "A String", # Output only. The time the config was updated. "vpnTunnel": "A String", # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name} } diff --git a/docs/dyn/networkservices_v1.projects.locations.html b/docs/dyn/networkservices_v1.projects.locations.html index 9530da1cc8..cdbb821756 100644 --- a/docs/dyn/networkservices_v1.projects.locations.html +++ b/docs/dyn/networkservices_v1.projects.locations.html @@ -149,6 +149,11 @@

Instance Methods

Returns the tlsRoutes Resource.

+

+ wasmPlugins() +

+

Returns the wasmPlugins Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/networkservices_v1.projects.locations.lbRouteExtensions.html b/docs/dyn/networkservices_v1.projects.locations.lbRouteExtensions.html index b903151be4..95022705be 100644 --- a/docs/dyn/networkservices_v1.projects.locations.lbRouteExtensions.html +++ b/docs/dyn/networkservices_v1.projects.locations.lbRouteExtensions.html @@ -117,17 +117,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions and must not be set. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. + "a_key": "", # Properties of the object. + }, "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. - "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, this must be a reference to a [wasm plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource. "A String", ], - "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions. + "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for callout extensions. This field is not supported for plugin extensions and must not be set. }, ], "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request. @@ -143,7 +146,7 @@

Method Details

"a_key": "A String", }, "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`. @@ -238,17 +241,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions and must not be set. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. + "a_key": "", # Properties of the object. + }, "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. - "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, this must be a reference to a [wasm plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource. "A String", ], - "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions. + "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for callout extensions. This field is not supported for plugin extensions and must not be set. }, ], "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request. @@ -264,7 +270,7 @@

Method Details

"a_key": "A String", }, "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`. @@ -299,17 +305,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions and must not be set. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. + "a_key": "", # Properties of the object. + }, "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. - "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, this must be a reference to a [wasm plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource. "A String", ], - "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions. + "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for callout extensions. This field is not supported for plugin extensions and must not be set. }, ], "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request. @@ -325,7 +334,7 @@

Method Details

"a_key": "A String", }, "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`. @@ -369,17 +378,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions and must not be set. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. + "a_key": "", # Properties of the object. + }, "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. - "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, this must be a reference to a [wasm plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource. "A String", ], - "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions. + "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for callout extensions. This field is not supported for plugin extensions and must not be set. }, ], "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request. @@ -395,7 +407,7 @@

Method Details

"a_key": "A String", }, "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`. diff --git a/docs/dyn/networkservices_v1.projects.locations.lbTrafficExtensions.html b/docs/dyn/networkservices_v1.projects.locations.lbTrafficExtensions.html index 6bf768e0a2..5ffe99af8c 100644 --- a/docs/dyn/networkservices_v1.projects.locations.lbTrafficExtensions.html +++ b/docs/dyn/networkservices_v1.projects.locations.lbTrafficExtensions.html @@ -117,17 +117,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions and must not be set. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. + "a_key": "", # Properties of the object. + }, "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. - "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, this must be a reference to a [wasm plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource. "A String", ], - "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions. + "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for callout extensions. This field is not supported for plugin extensions and must not be set. }, ], "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request. @@ -143,7 +146,7 @@

Method Details

"a_key": "A String", }, "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "metadata": { # Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. + "metadata": { # Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `LbTrafficExtension` resource in the following format: `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`. @@ -238,17 +241,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions and must not be set. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. + "a_key": "", # Properties of the object. + }, "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. - "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, this must be a reference to a [wasm plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource. "A String", ], - "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions. + "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for callout extensions. This field is not supported for plugin extensions and must not be set. }, ], "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request. @@ -264,7 +270,7 @@

Method Details

"a_key": "A String", }, "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "metadata": { # Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. + "metadata": { # Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `LbTrafficExtension` resource in the following format: `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`. @@ -299,17 +305,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions and must not be set. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. + "a_key": "", # Properties of the object. + }, "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. - "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, this must be a reference to a [wasm plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource. "A String", ], - "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions. + "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for callout extensions. This field is not supported for plugin extensions and must not be set. }, ], "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request. @@ -325,7 +334,7 @@

Method Details

"a_key": "A String", }, "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "metadata": { # Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. + "metadata": { # Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `LbTrafficExtension` resource in the following format: `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`. @@ -369,17 +378,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions and must not be set. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. + "a_key": "", # Properties of the object. + }, "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. - "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, this must be a reference to a [wasm plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource. "A String", ], - "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions. + "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for callout extensions. This field is not supported for plugin extensions and must not be set. }, ], "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request. @@ -395,7 +407,7 @@

Method Details

"a_key": "A String", }, "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "metadata": { # Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. + "metadata": { # Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `LbTrafficExtension` resource in the following format: `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`. diff --git a/docs/dyn/networkservices_v1.projects.locations.serviceLbPolicies.html b/docs/dyn/networkservices_v1.projects.locations.serviceLbPolicies.html index 3e960c2b98..7b36ea1be5 100644 --- a/docs/dyn/networkservices_v1.projects.locations.serviceLbPolicies.html +++ b/docs/dyn/networkservices_v1.projects.locations.serviceLbPolicies.html @@ -123,7 +123,7 @@

Method Details

"a_key": "A String", }, "loadBalancingAlgorithm": "A String", # Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION. - "name": "A String", # Required. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. + "name": "A String", # Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. "updateTime": "A String", # Output only. The timestamp when this resource was last updated. } @@ -219,7 +219,7 @@

Method Details

"a_key": "A String", }, "loadBalancingAlgorithm": "A String", # Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION. - "name": "A String", # Required. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. + "name": "A String", # Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. "updateTime": "A String", # Output only. The timestamp when this resource was last updated. }
@@ -256,7 +256,7 @@

Method Details

"a_key": "A String", }, "loadBalancingAlgorithm": "A String", # Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION. - "name": "A String", # Required. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. + "name": "A String", # Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. "updateTime": "A String", # Output only. The timestamp when this resource was last updated. }, ], @@ -282,7 +282,7 @@

Method Details

Updates the parameters of a single ServiceLbPolicy.
 
 Args:
-  name: string, Required. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. (required)
+  name: string, Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -299,7 +299,7 @@ 

Method Details

"a_key": "A String", }, "loadBalancingAlgorithm": "A String", # Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION. - "name": "A String", # Required. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. + "name": "A String", # Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. "updateTime": "A String", # Output only. The timestamp when this resource was last updated. } diff --git a/docs/dyn/networkservices_v1.projects.locations.wasmPlugins.html b/docs/dyn/networkservices_v1.projects.locations.wasmPlugins.html new file mode 100644 index 0000000000..de3b698091 --- /dev/null +++ b/docs/dyn/networkservices_v1.projects.locations.wasmPlugins.html @@ -0,0 +1,422 @@ + + + +

Network Services API . projects . locations . wasmPlugins

+

Instance Methods

+

+ versions() +

+

Returns the versions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new `WasmPlugin` resource in a given project and location.

+

+ delete(name, x__xgafv=None)

+

Deletes the specified `WasmPlugin` resource.

+

+ get(name, view=None, x__xgafv=None)

+

Gets details of the specified `WasmPlugin` resource.

+

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

+

Lists `WasmPlugin` resources in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the parameters of the specified `WasmPlugin` resource.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, wasmPluginId=None, x__xgafv=None) +
Creates a new `WasmPlugin` resource in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource of the `WasmPlugin` resource. Must be in the format `projects/{project}/locations/global`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `WasmPlugin` is a resource representing a service executing a customer-provided Wasm module.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A human-readable description of the resource.
+  "labels": { # Optional. Set of labels associated with the `WasmPlugin` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).
+    "a_key": "A String",
+  },
+  "logConfig": { # Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging. # Optional. Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging. Note that the settings relate to the logs generated by using logging statements in your Wasm code.
+    "enable": True or False, # Optional. Specifies whether to enable logging for activity by this `WasmPlugin`. Defaults to `false`.
+    "minLogLevel": "A String", # Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the `WasmPlugin` resource. If the field is not provided when logging is enabled, it is set to `INFO` by default.
+    "sampleRate": 3.14, # Non-empty default. Configures the sampling rate of activity logs, where `1.0` means all logged activity is reported and `0.0` means no activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must be between `0` and `1` (inclusive). This field can only be specified if logging is enabled for this `WasmPlugin`.
+  },
+  "mainVersionId": "A String", # Optional. The ID of the `WasmPluginVersion` resource that is the currently serving one. The version referred to must be a child of this `WasmPlugin` resource.
+  "name": "A String", # Identifier. Name of the `WasmPlugin` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}`.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+  "usedBy": [ # Output only. List of all [Service Extensions](https://cloud.google.com/service-extensions/docs/overview) that use this `WasmPlugin`.
+    { # Defines a resource that uses the `WasmPlugin`.
+      "name": "A String", # Output only. Full name of the resource https://google.aip.dev/122#full-resource-names, e.g. `//networkservices.googleapis.com/projects/{project}/locations/{location}/lbRouteExtensions/{extension}`
+    },
+  ],
+  "versions": { # Optional. All versions of this `WasmPlugin` in the key-value format. The key is the resource ID, the value is the `VersionDetails`. Allows to create or update `WasmPlugin` and its WasmPluginVersions in a single request. When the `main_version_id` field is not empty it must point to one of the VersionDetails in the map. If provided in the update request, the new versions replace the previous set. Any version omitted from the `versions` will be removed. Since the `WasmPluginVersion` resource is immutable, if the WasmPluginVersion with the same name already exists and differs the Update request will fail. Note: In the GET request, this field is populated only if the GetWasmPluginRequest.view is set to WASM_PLUGIN_VIEW_FULL.
+    "a_key": { # Details of a `WasmPluginVersion` resource to be inlined in the `WasmPlugin` resource.
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "description": "A String", # Optional. A human-readable description of the resource.
+      "imageDigest": "A String", # Output only. The resolved digest for the image specified in `image`. The digest is resolved during the creation of a `WasmPluginVersion` resource. This field holds the digest value regardless of whether a tag or digest was originally specified in the `image` field.
+      "imageUri": "A String", # Optional. URI of the container image containing the Wasm module, stored in the Artifact Registry. The container image must contain only a single file with the name `plugin.wasm`. When a new `WasmPluginVersion` resource is created, the URI gets resolved to an image digest and saved in the `image_digest` field.
+      "labels": { # Optional. Set of labels associated with the `WasmPluginVersion` resource.
+        "a_key": "A String",
+      },
+      "pluginConfigData": "A String", # Configuration for the Wasm plugin. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When a new `WasmPluginVersion` version is created, the digest of the contents is saved in the `plugin_config_digest` field.
+      "pluginConfigDigest": "A String", # Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of the `plugin_config_data` or the container image defined by the `plugin_config_uri` field.
+      "pluginConfigUri": "A String", # URI of the WasmPlugin configuration stored in the Artifact Registry. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. The container image must contain only a single file with the name `plugin.config`. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `plugin_config_digest` field.
+      "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+    },
+  },
+}
+
+  wasmPluginId: string, Required. User-provided ID of the `WasmPlugin` resource to be created.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes the specified `WasmPlugin` resource.
+
+Args:
+  name: string, Required. A name of the `WasmPlugin` resource to delete. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, view=None, x__xgafv=None) +
Gets details of the specified `WasmPlugin` resource.
+
+Args:
+  name: string, Required. A name of the `WasmPlugin` resource to get. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`. (required)
+  view: string, Determine how much data should be returned by the API. See [AIP-157](https://google.aip.dev/157).
+    Allowed values
+      WASM_PLUGIN_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
+      WASM_PLUGIN_VIEW_BASIC - Include just WasmPlugin record.
+      WASM_PLUGIN_VIEW_FULL - Include WasmPlugin record and all its WasmPluginVersions.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `WasmPlugin` is a resource representing a service executing a customer-provided Wasm module.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A human-readable description of the resource.
+  "labels": { # Optional. Set of labels associated with the `WasmPlugin` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).
+    "a_key": "A String",
+  },
+  "logConfig": { # Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging. # Optional. Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging. Note that the settings relate to the logs generated by using logging statements in your Wasm code.
+    "enable": True or False, # Optional. Specifies whether to enable logging for activity by this `WasmPlugin`. Defaults to `false`.
+    "minLogLevel": "A String", # Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the `WasmPlugin` resource. If the field is not provided when logging is enabled, it is set to `INFO` by default.
+    "sampleRate": 3.14, # Non-empty default. Configures the sampling rate of activity logs, where `1.0` means all logged activity is reported and `0.0` means no activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must be between `0` and `1` (inclusive). This field can only be specified if logging is enabled for this `WasmPlugin`.
+  },
+  "mainVersionId": "A String", # Optional. The ID of the `WasmPluginVersion` resource that is the currently serving one. The version referred to must be a child of this `WasmPlugin` resource.
+  "name": "A String", # Identifier. Name of the `WasmPlugin` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}`.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+  "usedBy": [ # Output only. List of all [Service Extensions](https://cloud.google.com/service-extensions/docs/overview) that use this `WasmPlugin`.
+    { # Defines a resource that uses the `WasmPlugin`.
+      "name": "A String", # Output only. Full name of the resource https://google.aip.dev/122#full-resource-names, e.g. `//networkservices.googleapis.com/projects/{project}/locations/{location}/lbRouteExtensions/{extension}`
+    },
+  ],
+  "versions": { # Optional. All versions of this `WasmPlugin` in the key-value format. The key is the resource ID, the value is the `VersionDetails`. Allows to create or update `WasmPlugin` and its WasmPluginVersions in a single request. When the `main_version_id` field is not empty it must point to one of the VersionDetails in the map. If provided in the update request, the new versions replace the previous set. Any version omitted from the `versions` will be removed. Since the `WasmPluginVersion` resource is immutable, if the WasmPluginVersion with the same name already exists and differs the Update request will fail. Note: In the GET request, this field is populated only if the GetWasmPluginRequest.view is set to WASM_PLUGIN_VIEW_FULL.
+    "a_key": { # Details of a `WasmPluginVersion` resource to be inlined in the `WasmPlugin` resource.
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "description": "A String", # Optional. A human-readable description of the resource.
+      "imageDigest": "A String", # Output only. The resolved digest for the image specified in `image`. The digest is resolved during the creation of a `WasmPluginVersion` resource. This field holds the digest value regardless of whether a tag or digest was originally specified in the `image` field.
+      "imageUri": "A String", # Optional. URI of the container image containing the Wasm module, stored in the Artifact Registry. The container image must contain only a single file with the name `plugin.wasm`. When a new `WasmPluginVersion` resource is created, the URI gets resolved to an image digest and saved in the `image_digest` field.
+      "labels": { # Optional. Set of labels associated with the `WasmPluginVersion` resource.
+        "a_key": "A String",
+      },
+      "pluginConfigData": "A String", # Configuration for the Wasm plugin. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When a new `WasmPluginVersion` version is created, the digest of the contents is saved in the `plugin_config_digest` field.
+      "pluginConfigDigest": "A String", # Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of the `plugin_config_data` or the container image defined by the `plugin_config_uri` field.
+      "pluginConfigUri": "A String", # URI of the WasmPlugin configuration stored in the Artifact Registry. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. The container image must contain only a single file with the name `plugin.config`. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `plugin_config_digest` field.
+      "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+    },
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists `WasmPlugin` resources in a given project and location.
+
+Args:
+  parent: string, Required. The project and location from which the `WasmPlugin` resources are listed, specified in the following format: `projects/{project}/locations/global`. (required)
+  pageSize: integer, Maximum number of `WasmPlugin` resources to return per call. If not specified, at most 50 `WasmPlugin`s are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
+  pageToken: string, The value returned by the last `ListWasmPluginsResponse` call. Indicates that this is a continuation of a prior `ListWasmPlugins` call, and that the next page of data is to be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response returned by the `ListWasmPlugins` method.
+  "nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
+  "wasmPlugins": [ # List of `WasmPlugin` resources.
+    { # `WasmPlugin` is a resource representing a service executing a customer-provided Wasm module.
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "description": "A String", # Optional. A human-readable description of the resource.
+      "labels": { # Optional. Set of labels associated with the `WasmPlugin` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).
+        "a_key": "A String",
+      },
+      "logConfig": { # Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging. # Optional. Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging. Note that the settings relate to the logs generated by using logging statements in your Wasm code.
+        "enable": True or False, # Optional. Specifies whether to enable logging for activity by this `WasmPlugin`. Defaults to `false`.
+        "minLogLevel": "A String", # Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the `WasmPlugin` resource. If the field is not provided when logging is enabled, it is set to `INFO` by default.
+        "sampleRate": 3.14, # Non-empty default. Configures the sampling rate of activity logs, where `1.0` means all logged activity is reported and `0.0` means no activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must be between `0` and `1` (inclusive). This field can only be specified if logging is enabled for this `WasmPlugin`.
+      },
+      "mainVersionId": "A String", # Optional. The ID of the `WasmPluginVersion` resource that is the currently serving one. The version referred to must be a child of this `WasmPlugin` resource.
+      "name": "A String", # Identifier. Name of the `WasmPlugin` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}`.
+      "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+      "usedBy": [ # Output only. List of all [Service Extensions](https://cloud.google.com/service-extensions/docs/overview) that use this `WasmPlugin`.
+        { # Defines a resource that uses the `WasmPlugin`.
+          "name": "A String", # Output only. Full name of the resource https://google.aip.dev/122#full-resource-names, e.g. `//networkservices.googleapis.com/projects/{project}/locations/{location}/lbRouteExtensions/{extension}`
+        },
+      ],
+      "versions": { # Optional. All versions of this `WasmPlugin` in the key-value format. The key is the resource ID, the value is the `VersionDetails`. Allows to create or update `WasmPlugin` and its WasmPluginVersions in a single request. When the `main_version_id` field is not empty it must point to one of the VersionDetails in the map. If provided in the update request, the new versions replace the previous set. Any version omitted from the `versions` will be removed. Since the `WasmPluginVersion` resource is immutable, if the WasmPluginVersion with the same name already exists and differs the Update request will fail. Note: In the GET request, this field is populated only if the GetWasmPluginRequest.view is set to WASM_PLUGIN_VIEW_FULL.
+        "a_key": { # Details of a `WasmPluginVersion` resource to be inlined in the `WasmPlugin` resource.
+          "createTime": "A String", # Output only. The timestamp when the resource was created.
+          "description": "A String", # Optional. A human-readable description of the resource.
+          "imageDigest": "A String", # Output only. The resolved digest for the image specified in `image`. The digest is resolved during the creation of a `WasmPluginVersion` resource. This field holds the digest value regardless of whether a tag or digest was originally specified in the `image` field.
+          "imageUri": "A String", # Optional. URI of the container image containing the Wasm module, stored in the Artifact Registry. The container image must contain only a single file with the name `plugin.wasm`. When a new `WasmPluginVersion` resource is created, the URI gets resolved to an image digest and saved in the `image_digest` field.
+          "labels": { # Optional. Set of labels associated with the `WasmPluginVersion` resource.
+            "a_key": "A String",
+          },
+          "pluginConfigData": "A String", # Configuration for the Wasm plugin. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When a new `WasmPluginVersion` version is created, the digest of the contents is saved in the `plugin_config_digest` field.
+          "pluginConfigDigest": "A String", # Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of the `plugin_config_data` or the container image defined by the `plugin_config_uri` field.
+          "pluginConfigUri": "A String", # URI of the WasmPlugin configuration stored in the Artifact Registry. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. The container image must contain only a single file with the name `plugin.config`. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `plugin_config_digest` field.
+          "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+        },
+      },
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the parameters of the specified `WasmPlugin` resource.
+
+Args:
+  name: string, Identifier. Name of the `WasmPlugin` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `WasmPlugin` is a resource representing a service executing a customer-provided Wasm module.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A human-readable description of the resource.
+  "labels": { # Optional. Set of labels associated with the `WasmPlugin` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).
+    "a_key": "A String",
+  },
+  "logConfig": { # Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging. # Optional. Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging. Note that the settings relate to the logs generated by using logging statements in your Wasm code.
+    "enable": True or False, # Optional. Specifies whether to enable logging for activity by this `WasmPlugin`. Defaults to `false`.
+    "minLogLevel": "A String", # Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the `WasmPlugin` resource. If the field is not provided when logging is enabled, it is set to `INFO` by default.
+    "sampleRate": 3.14, # Non-empty default. Configures the sampling rate of activity logs, where `1.0` means all logged activity is reported and `0.0` means no activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must be between `0` and `1` (inclusive). This field can only be specified if logging is enabled for this `WasmPlugin`.
+  },
+  "mainVersionId": "A String", # Optional. The ID of the `WasmPluginVersion` resource that is the currently serving one. The version referred to must be a child of this `WasmPlugin` resource.
+  "name": "A String", # Identifier. Name of the `WasmPlugin` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}`.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+  "usedBy": [ # Output only. List of all [Service Extensions](https://cloud.google.com/service-extensions/docs/overview) that use this `WasmPlugin`.
+    { # Defines a resource that uses the `WasmPlugin`.
+      "name": "A String", # Output only. Full name of the resource https://google.aip.dev/122#full-resource-names, e.g. `//networkservices.googleapis.com/projects/{project}/locations/{location}/lbRouteExtensions/{extension}`
+    },
+  ],
+  "versions": { # Optional. All versions of this `WasmPlugin` in the key-value format. The key is the resource ID, the value is the `VersionDetails`. Allows to create or update `WasmPlugin` and its WasmPluginVersions in a single request. When the `main_version_id` field is not empty it must point to one of the VersionDetails in the map. If provided in the update request, the new versions replace the previous set. Any version omitted from the `versions` will be removed. Since the `WasmPluginVersion` resource is immutable, if the WasmPluginVersion with the same name already exists and differs the Update request will fail. Note: In the GET request, this field is populated only if the GetWasmPluginRequest.view is set to WASM_PLUGIN_VIEW_FULL.
+    "a_key": { # Details of a `WasmPluginVersion` resource to be inlined in the `WasmPlugin` resource.
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "description": "A String", # Optional. A human-readable description of the resource.
+      "imageDigest": "A String", # Output only. The resolved digest for the image specified in `image`. The digest is resolved during the creation of a `WasmPluginVersion` resource. This field holds the digest value regardless of whether a tag or digest was originally specified in the `image` field.
+      "imageUri": "A String", # Optional. URI of the container image containing the Wasm module, stored in the Artifact Registry. The container image must contain only a single file with the name `plugin.wasm`. When a new `WasmPluginVersion` resource is created, the URI gets resolved to an image digest and saved in the `image_digest` field.
+      "labels": { # Optional. Set of labels associated with the `WasmPluginVersion` resource.
+        "a_key": "A String",
+      },
+      "pluginConfigData": "A String", # Configuration for the Wasm plugin. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When a new `WasmPluginVersion` version is created, the digest of the contents is saved in the `plugin_config_digest` field.
+      "pluginConfigDigest": "A String", # Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of the `plugin_config_data` or the container image defined by the `plugin_config_uri` field.
+      "pluginConfigUri": "A String", # URI of the WasmPlugin configuration stored in the Artifact Registry. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. The container image must contain only a single file with the name `plugin.config`. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `plugin_config_digest` field.
+      "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+    },
+  },
+}
+
+  updateMask: string, Optional. Used to specify the fields to be overwritten in the `WasmPlugin` resource by the update. The fields specified in the `update_mask` field are relative to the resource, not the full request. An omitted `update_mask` field is treated as an implied `update_mask` field equivalent to all fields that are populated (that have a non-empty value). The `update_mask` field supports a special value `*`, which means that each field in the given `WasmPlugin` resource (including the empty ones) replaces the current value.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/networkservices_v1.projects.locations.wasmPlugins.versions.html b/docs/dyn/networkservices_v1.projects.locations.wasmPlugins.versions.html new file mode 100644 index 0000000000..2db61d1b94 --- /dev/null +++ b/docs/dyn/networkservices_v1.projects.locations.wasmPlugins.versions.html @@ -0,0 +1,271 @@ + + + +

Network Services API . projects . locations . wasmPlugins . versions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new `WasmPluginVersion` resource in a given project and location.

+

+ delete(name, x__xgafv=None)

+

Deletes the specified `WasmPluginVersion` resource.

+

+ get(name, x__xgafv=None)

+

Gets details of the specified `WasmPluginVersion` resource.

+

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

+

Lists `WasmPluginVersion` resources in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, wasmPluginVersionId=None, x__xgafv=None) +
Creates a new `WasmPluginVersion` resource in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource of the `WasmPluginVersion` resource. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single immutable version of a `WasmPlugin`. Defines the Wasm module used and optionally its runtime config.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A human-readable description of the resource.
+  "imageDigest": "A String", # Output only. The resolved digest for the image specified in `image`. The digest is resolved during the creation of `WasmPluginVersion` resource. This field holds the digest value regardless of whether a tag or digest was originally specified in the `image` field.
+  "imageUri": "A String", # Optional. URI of the container image containing the Wasm plugin, stored in the Artifact Registry. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `image_digest` field. When downloading an image, the digest value is used instead of an image tag.
+  "labels": { # Optional. Set of labels associated with the `WasmPluginVersion` resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the `WasmPluginVersion` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}/ versions/{wasm_plugin_version}`.
+  "pluginConfigData": "A String", # Configuration for the Wasm plugin. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When a new `WasmPluginVersion` resource is created, the digest of the contents is saved in the `plugin_config_digest` field.
+  "pluginConfigDigest": "A String", # Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of the `plugin_config_data` or the container image defined by the `plugin_config_uri` field.
+  "pluginConfigUri": "A String", # URI of the Wasm plugin configuration stored in the Artifact Registry. The configuration is provided to the plugin at runtime through the `ON_CONFIGURE` callback. The container image must contain only a single file with the name `plugin.config`. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `plugin_config_digest` field.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}
+
+  wasmPluginVersionId: string, Required. User-provided ID of the `WasmPluginVersion` resource to be created.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes the specified `WasmPluginVersion` resource.
+
+Args:
+  name: string, Required. A name of the `WasmPluginVersion` resource to delete. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}/versions/{wasm_plugin_version}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets details of the specified `WasmPluginVersion` resource.
+
+Args:
+  name: string, Required. A name of the `WasmPluginVersion` resource to get. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}/versions/{wasm_plugin_version}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single immutable version of a `WasmPlugin`. Defines the Wasm module used and optionally its runtime config.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A human-readable description of the resource.
+  "imageDigest": "A String", # Output only. The resolved digest for the image specified in `image`. The digest is resolved during the creation of `WasmPluginVersion` resource. This field holds the digest value regardless of whether a tag or digest was originally specified in the `image` field.
+  "imageUri": "A String", # Optional. URI of the container image containing the Wasm plugin, stored in the Artifact Registry. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `image_digest` field. When downloading an image, the digest value is used instead of an image tag.
+  "labels": { # Optional. Set of labels associated with the `WasmPluginVersion` resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the `WasmPluginVersion` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}/ versions/{wasm_plugin_version}`.
+  "pluginConfigData": "A String", # Configuration for the Wasm plugin. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When a new `WasmPluginVersion` resource is created, the digest of the contents is saved in the `plugin_config_digest` field.
+  "pluginConfigDigest": "A String", # Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of the `plugin_config_data` or the container image defined by the `plugin_config_uri` field.
+  "pluginConfigUri": "A String", # URI of the Wasm plugin configuration stored in the Artifact Registry. The configuration is provided to the plugin at runtime through the `ON_CONFIGURE` callback. The container image must contain only a single file with the name `plugin.config`. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `plugin_config_digest` field.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists `WasmPluginVersion` resources in a given project and location.
+
+Args:
+  parent: string, Required. The `WasmPlugin` resource whose `WasmPluginVersion`s are listed, specified in the following format: `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`. (required)
+  pageSize: integer, Maximum number of `WasmPluginVersion` resources to return per call. If not specified, at most 50 `WasmPluginVersion`s are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
+  pageToken: string, The value returned by the last `ListWasmPluginVersionsResponse` call. Indicates that this is a continuation of a prior `ListWasmPluginVersions` call, and that the next page of data is to be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response returned by the `ListWasmPluginVersions` method.
+  "nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
+  "wasmPluginVersions": [ # List of `WasmPluginVersion` resources.
+    { # A single immutable version of a `WasmPlugin`. Defines the Wasm module used and optionally its runtime config.
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "description": "A String", # Optional. A human-readable description of the resource.
+      "imageDigest": "A String", # Output only. The resolved digest for the image specified in `image`. The digest is resolved during the creation of `WasmPluginVersion` resource. This field holds the digest value regardless of whether a tag or digest was originally specified in the `image` field.
+      "imageUri": "A String", # Optional. URI of the container image containing the Wasm plugin, stored in the Artifact Registry. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `image_digest` field. When downloading an image, the digest value is used instead of an image tag.
+      "labels": { # Optional. Set of labels associated with the `WasmPluginVersion` resource.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. Name of the `WasmPluginVersion` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}/ versions/{wasm_plugin_version}`.
+      "pluginConfigData": "A String", # Configuration for the Wasm plugin. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When a new `WasmPluginVersion` resource is created, the digest of the contents is saved in the `plugin_config_digest` field.
+      "pluginConfigDigest": "A String", # Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of the `plugin_config_data` or the container image defined by the `plugin_config_uri` field.
+      "pluginConfigUri": "A String", # URI of the Wasm plugin configuration stored in the Artifact Registry. The configuration is provided to the plugin at runtime through the `ON_CONFIGURE` callback. The container image must contain only a single file with the name `plugin.config`. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `plugin_config_digest` field.
+      "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.html b/docs/dyn/networkservices_v1beta1.projects.locations.html index 02899c3daa..8ed5921ccc 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.html @@ -139,6 +139,11 @@

Instance Methods

Returns the tlsRoutes Resource.

+

+ wasmPlugins() +

+

Returns the wasmPlugins Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.lbRouteExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.lbRouteExtensions.html index 4d110bc18e..62107e111c 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.lbRouteExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.lbRouteExtensions.html @@ -117,17 +117,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions and must not be set. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. + "a_key": "", # Properties of the object. + }, "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. - "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, this must be a reference to a [wasm plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource. "A String", ], - "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions. + "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for callout extensions. This field is not supported for plugin extensions and must not be set. }, ], "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request. @@ -143,7 +146,7 @@

Method Details

"a_key": "A String", }, "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`. @@ -238,17 +241,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions and must not be set. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. + "a_key": "", # Properties of the object. + }, "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. - "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, this must be a reference to a [wasm plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource. "A String", ], - "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions. + "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for callout extensions. This field is not supported for plugin extensions and must not be set. }, ], "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request. @@ -264,7 +270,7 @@

Method Details

"a_key": "A String", }, "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`. @@ -299,17 +305,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions and must not be set. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. + "a_key": "", # Properties of the object. + }, "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. - "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, this must be a reference to a [wasm plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource. "A String", ], - "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions. + "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for callout extensions. This field is not supported for plugin extensions and must not be set. }, ], "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request. @@ -325,7 +334,7 @@

Method Details

"a_key": "A String", }, "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`. @@ -369,17 +378,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions and must not be set. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. + "a_key": "", # Properties of the object. + }, "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. - "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, this must be a reference to a [wasm plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource. "A String", ], - "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions. + "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for callout extensions. This field is not supported for plugin extensions and must not be set. }, ], "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request. @@ -395,7 +407,7 @@

Method Details

"a_key": "A String", }, "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`. diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.lbTrafficExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.lbTrafficExtensions.html index 3169dcc4e8..c80fd740a1 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.lbTrafficExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.lbTrafficExtensions.html @@ -117,17 +117,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions and must not be set. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. + "a_key": "", # Properties of the object. + }, "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. - "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, this must be a reference to a [wasm plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource. "A String", ], - "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions. + "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for callout extensions. This field is not supported for plugin extensions and must not be set. }, ], "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request. @@ -143,7 +146,7 @@

Method Details

"a_key": "A String", }, "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "metadata": { # Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. + "metadata": { # Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `LbTrafficExtension` resource in the following format: `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`. @@ -238,17 +241,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions and must not be set. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. + "a_key": "", # Properties of the object. + }, "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. - "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, this must be a reference to a [wasm plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource. "A String", ], - "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions. + "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for callout extensions. This field is not supported for plugin extensions and must not be set. }, ], "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request. @@ -264,7 +270,7 @@

Method Details

"a_key": "A String", }, "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "metadata": { # Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. + "metadata": { # Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `LbTrafficExtension` resource in the following format: `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`. @@ -299,17 +305,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions and must not be set. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. + "a_key": "", # Properties of the object. + }, "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. - "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, this must be a reference to a [wasm plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource. "A String", ], - "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions. + "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for callout extensions. This field is not supported for plugin extensions and must not be set. }, ], "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request. @@ -325,7 +334,7 @@

Method Details

"a_key": "A String", }, "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "metadata": { # Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. + "metadata": { # Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `LbTrafficExtension` resource in the following format: `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`. @@ -369,17 +378,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions and must not be set. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. + "a_key": "", # Properties of the object. + }, "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. - "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, this must be a reference to a [wasm plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource. "A String", ], - "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions. + "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for callout extensions. This field is not supported for plugin extensions and must not be set. }, ], "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request. @@ -395,7 +407,7 @@

Method Details

"a_key": "A String", }, "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "metadata": { # Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. + "metadata": { # Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `LbTrafficExtension` resource in the following format: `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`. diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.serviceLbPolicies.html b/docs/dyn/networkservices_v1beta1.projects.locations.serviceLbPolicies.html index 1c39b8a52f..182aae4ad4 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.serviceLbPolicies.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.serviceLbPolicies.html @@ -123,7 +123,7 @@

Method Details

"a_key": "A String", }, "loadBalancingAlgorithm": "A String", # Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION. - "name": "A String", # Required. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. + "name": "A String", # Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. "updateTime": "A String", # Output only. The timestamp when this resource was last updated. } @@ -219,7 +219,7 @@

Method Details

"a_key": "A String", }, "loadBalancingAlgorithm": "A String", # Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION. - "name": "A String", # Required. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. + "name": "A String", # Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. "updateTime": "A String", # Output only. The timestamp when this resource was last updated. }
@@ -256,7 +256,7 @@

Method Details

"a_key": "A String", }, "loadBalancingAlgorithm": "A String", # Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION. - "name": "A String", # Required. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. + "name": "A String", # Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. "updateTime": "A String", # Output only. The timestamp when this resource was last updated. }, ], @@ -282,7 +282,7 @@

Method Details

Updates the parameters of a single ServiceLbPolicy.
 
 Args:
-  name: string, Required. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. (required)
+  name: string, Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -299,7 +299,7 @@ 

Method Details

"a_key": "A String", }, "loadBalancingAlgorithm": "A String", # Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION. - "name": "A String", # Required. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. + "name": "A String", # Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. "updateTime": "A String", # Output only. The timestamp when this resource was last updated. } diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.wasmPlugins.html b/docs/dyn/networkservices_v1beta1.projects.locations.wasmPlugins.html new file mode 100644 index 0000000000..d09bceff8c --- /dev/null +++ b/docs/dyn/networkservices_v1beta1.projects.locations.wasmPlugins.html @@ -0,0 +1,422 @@ + + + +

Network Services API . projects . locations . wasmPlugins

+

Instance Methods

+

+ versions() +

+

Returns the versions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new `WasmPlugin` resource in a given project and location.

+

+ delete(name, x__xgafv=None)

+

Deletes the specified `WasmPlugin` resource.

+

+ get(name, view=None, x__xgafv=None)

+

Gets details of the specified `WasmPlugin` resource.

+

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

+

Lists `WasmPlugin` resources in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the parameters of the specified `WasmPlugin` resource.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, wasmPluginId=None, x__xgafv=None) +
Creates a new `WasmPlugin` resource in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource of the `WasmPlugin` resource. Must be in the format `projects/{project}/locations/global`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `WasmPlugin` is a resource representing a service executing a customer-provided Wasm module.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A human-readable description of the resource.
+  "labels": { # Optional. Set of labels associated with the `WasmPlugin` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).
+    "a_key": "A String",
+  },
+  "logConfig": { # Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging. # Optional. Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging. Note that the settings relate to the logs generated by using logging statements in your Wasm code.
+    "enable": True or False, # Optional. Specifies whether to enable logging for activity by this `WasmPlugin`. Defaults to `false`.
+    "minLogLevel": "A String", # Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the `WasmPlugin` resource. If the field is not provided when logging is enabled, it is set to `INFO` by default.
+    "sampleRate": 3.14, # Non-empty default. Configures the sampling rate of activity logs, where `1.0` means all logged activity is reported and `0.0` means no activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must be between `0` and `1` (inclusive). This field can only be specified if logging is enabled for this `WasmPlugin`.
+  },
+  "mainVersionId": "A String", # Optional. The ID of the `WasmPluginVersion` resource that is the currently serving one. The version referred to must be a child of this `WasmPlugin` resource.
+  "name": "A String", # Identifier. Name of the `WasmPlugin` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}`.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+  "usedBy": [ # Output only. List of all [Service Extensions](https://cloud.google.com/service-extensions/docs/overview) that use this `WasmPlugin`.
+    { # Defines a resource that uses the `WasmPlugin`.
+      "name": "A String", # Output only. Full name of the resource https://google.aip.dev/122#full-resource-names, e.g. `//networkservices.googleapis.com/projects/{project}/locations/{location}/lbRouteExtensions/{extension}`
+    },
+  ],
+  "versions": { # Optional. All versions of this `WasmPlugin` in the key-value format. The key is the resource ID, the value is the `VersionDetails`. Allows to create or update `WasmPlugin` and its WasmPluginVersions in a single request. When the `main_version_id` field is not empty it must point to one of the VersionDetails in the map. If provided in the update request, the new versions replace the previous set. Any version omitted from the `versions` will be removed. Since the `WasmPluginVersion` resource is immutable, if the WasmPluginVersion with the same name already exists and differs the Update request will fail. Note: In the GET request, this field is populated only if the GetWasmPluginRequest.view is set to WASM_PLUGIN_VIEW_FULL.
+    "a_key": { # Details of a `WasmPluginVersion` resource to be inlined in the `WasmPlugin` resource.
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "description": "A String", # Optional. A human-readable description of the resource.
+      "imageDigest": "A String", # Output only. The resolved digest for the image specified in `image`. The digest is resolved during the creation of a `WasmPluginVersion` resource. This field holds the digest value regardless of whether a tag or digest was originally specified in the `image` field.
+      "imageUri": "A String", # Optional. URI of the container image containing the Wasm module, stored in the Artifact Registry. The container image must contain only a single file with the name `plugin.wasm`. When a new `WasmPluginVersion` resource is created, the URI gets resolved to an image digest and saved in the `image_digest` field.
+      "labels": { # Optional. Set of labels associated with the `WasmPluginVersion` resource.
+        "a_key": "A String",
+      },
+      "pluginConfigData": "A String", # Configuration for the Wasm plugin. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When a new `WasmPluginVersion` version is created, the digest of the contents is saved in the `plugin_config_digest` field.
+      "pluginConfigDigest": "A String", # Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of the `plugin_config_data` or the container image defined by the `plugin_config_uri` field.
+      "pluginConfigUri": "A String", # URI of the WasmPlugin configuration stored in the Artifact Registry. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. The container image must contain only a single file with the name `plugin.config`. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `plugin_config_digest` field.
+      "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+    },
+  },
+}
+
+  wasmPluginId: string, Required. User-provided ID of the `WasmPlugin` resource to be created.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes the specified `WasmPlugin` resource.
+
+Args:
+  name: string, Required. A name of the `WasmPlugin` resource to delete. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, view=None, x__xgafv=None) +
Gets details of the specified `WasmPlugin` resource.
+
+Args:
+  name: string, Required. A name of the `WasmPlugin` resource to get. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`. (required)
+  view: string, Determine how much data should be returned by the API. See [AIP-157](https://google.aip.dev/157).
+    Allowed values
+      WASM_PLUGIN_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
+      WASM_PLUGIN_VIEW_BASIC - Include just WasmPlugin record.
+      WASM_PLUGIN_VIEW_FULL - Include WasmPlugin record and all its WasmPluginVersions.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `WasmPlugin` is a resource representing a service executing a customer-provided Wasm module.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A human-readable description of the resource.
+  "labels": { # Optional. Set of labels associated with the `WasmPlugin` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).
+    "a_key": "A String",
+  },
+  "logConfig": { # Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging. # Optional. Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging. Note that the settings relate to the logs generated by using logging statements in your Wasm code.
+    "enable": True or False, # Optional. Specifies whether to enable logging for activity by this `WasmPlugin`. Defaults to `false`.
+    "minLogLevel": "A String", # Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the `WasmPlugin` resource. If the field is not provided when logging is enabled, it is set to `INFO` by default.
+    "sampleRate": 3.14, # Non-empty default. Configures the sampling rate of activity logs, where `1.0` means all logged activity is reported and `0.0` means no activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must be between `0` and `1` (inclusive). This field can only be specified if logging is enabled for this `WasmPlugin`.
+  },
+  "mainVersionId": "A String", # Optional. The ID of the `WasmPluginVersion` resource that is the currently serving one. The version referred to must be a child of this `WasmPlugin` resource.
+  "name": "A String", # Identifier. Name of the `WasmPlugin` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}`.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+  "usedBy": [ # Output only. List of all [Service Extensions](https://cloud.google.com/service-extensions/docs/overview) that use this `WasmPlugin`.
+    { # Defines a resource that uses the `WasmPlugin`.
+      "name": "A String", # Output only. Full name of the resource https://google.aip.dev/122#full-resource-names, e.g. `//networkservices.googleapis.com/projects/{project}/locations/{location}/lbRouteExtensions/{extension}`
+    },
+  ],
+  "versions": { # Optional. All versions of this `WasmPlugin` in the key-value format. The key is the resource ID, the value is the `VersionDetails`. Allows to create or update `WasmPlugin` and its WasmPluginVersions in a single request. When the `main_version_id` field is not empty it must point to one of the VersionDetails in the map. If provided in the update request, the new versions replace the previous set. Any version omitted from the `versions` will be removed. Since the `WasmPluginVersion` resource is immutable, if the WasmPluginVersion with the same name already exists and differs the Update request will fail. Note: In the GET request, this field is populated only if the GetWasmPluginRequest.view is set to WASM_PLUGIN_VIEW_FULL.
+    "a_key": { # Details of a `WasmPluginVersion` resource to be inlined in the `WasmPlugin` resource.
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "description": "A String", # Optional. A human-readable description of the resource.
+      "imageDigest": "A String", # Output only. The resolved digest for the image specified in `image`. The digest is resolved during the creation of a `WasmPluginVersion` resource. This field holds the digest value regardless of whether a tag or digest was originally specified in the `image` field.
+      "imageUri": "A String", # Optional. URI of the container image containing the Wasm module, stored in the Artifact Registry. The container image must contain only a single file with the name `plugin.wasm`. When a new `WasmPluginVersion` resource is created, the URI gets resolved to an image digest and saved in the `image_digest` field.
+      "labels": { # Optional. Set of labels associated with the `WasmPluginVersion` resource.
+        "a_key": "A String",
+      },
+      "pluginConfigData": "A String", # Configuration for the Wasm plugin. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When a new `WasmPluginVersion` version is created, the digest of the contents is saved in the `plugin_config_digest` field.
+      "pluginConfigDigest": "A String", # Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of the `plugin_config_data` or the container image defined by the `plugin_config_uri` field.
+      "pluginConfigUri": "A String", # URI of the WasmPlugin configuration stored in the Artifact Registry. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. The container image must contain only a single file with the name `plugin.config`. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `plugin_config_digest` field.
+      "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+    },
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists `WasmPlugin` resources in a given project and location.
+
+Args:
+  parent: string, Required. The project and location from which the `WasmPlugin` resources are listed, specified in the following format: `projects/{project}/locations/global`. (required)
+  pageSize: integer, Maximum number of `WasmPlugin` resources to return per call. If not specified, at most 50 `WasmPlugin`s are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
+  pageToken: string, The value returned by the last `ListWasmPluginsResponse` call. Indicates that this is a continuation of a prior `ListWasmPlugins` call, and that the next page of data is to be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response returned by the `ListWasmPlugins` method.
+  "nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
+  "wasmPlugins": [ # List of `WasmPlugin` resources.
+    { # `WasmPlugin` is a resource representing a service executing a customer-provided Wasm module.
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "description": "A String", # Optional. A human-readable description of the resource.
+      "labels": { # Optional. Set of labels associated with the `WasmPlugin` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).
+        "a_key": "A String",
+      },
+      "logConfig": { # Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging. # Optional. Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging. Note that the settings relate to the logs generated by using logging statements in your Wasm code.
+        "enable": True or False, # Optional. Specifies whether to enable logging for activity by this `WasmPlugin`. Defaults to `false`.
+        "minLogLevel": "A String", # Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the `WasmPlugin` resource. If the field is not provided when logging is enabled, it is set to `INFO` by default.
+        "sampleRate": 3.14, # Non-empty default. Configures the sampling rate of activity logs, where `1.0` means all logged activity is reported and `0.0` means no activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must be between `0` and `1` (inclusive). This field can only be specified if logging is enabled for this `WasmPlugin`.
+      },
+      "mainVersionId": "A String", # Optional. The ID of the `WasmPluginVersion` resource that is the currently serving one. The version referred to must be a child of this `WasmPlugin` resource.
+      "name": "A String", # Identifier. Name of the `WasmPlugin` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}`.
+      "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+      "usedBy": [ # Output only. List of all [Service Extensions](https://cloud.google.com/service-extensions/docs/overview) that use this `WasmPlugin`.
+        { # Defines a resource that uses the `WasmPlugin`.
+          "name": "A String", # Output only. Full name of the resource https://google.aip.dev/122#full-resource-names, e.g. `//networkservices.googleapis.com/projects/{project}/locations/{location}/lbRouteExtensions/{extension}`
+        },
+      ],
+      "versions": { # Optional. All versions of this `WasmPlugin` in the key-value format. The key is the resource ID, the value is the `VersionDetails`. Allows to create or update `WasmPlugin` and its WasmPluginVersions in a single request. When the `main_version_id` field is not empty it must point to one of the VersionDetails in the map. If provided in the update request, the new versions replace the previous set. Any version omitted from the `versions` will be removed. Since the `WasmPluginVersion` resource is immutable, if the WasmPluginVersion with the same name already exists and differs the Update request will fail. Note: In the GET request, this field is populated only if the GetWasmPluginRequest.view is set to WASM_PLUGIN_VIEW_FULL.
+        "a_key": { # Details of a `WasmPluginVersion` resource to be inlined in the `WasmPlugin` resource.
+          "createTime": "A String", # Output only. The timestamp when the resource was created.
+          "description": "A String", # Optional. A human-readable description of the resource.
+          "imageDigest": "A String", # Output only. The resolved digest for the image specified in `image`. The digest is resolved during the creation of a `WasmPluginVersion` resource. This field holds the digest value regardless of whether a tag or digest was originally specified in the `image` field.
+          "imageUri": "A String", # Optional. URI of the container image containing the Wasm module, stored in the Artifact Registry. The container image must contain only a single file with the name `plugin.wasm`. When a new `WasmPluginVersion` resource is created, the URI gets resolved to an image digest and saved in the `image_digest` field.
+          "labels": { # Optional. Set of labels associated with the `WasmPluginVersion` resource.
+            "a_key": "A String",
+          },
+          "pluginConfigData": "A String", # Configuration for the Wasm plugin. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When a new `WasmPluginVersion` version is created, the digest of the contents is saved in the `plugin_config_digest` field.
+          "pluginConfigDigest": "A String", # Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of the `plugin_config_data` or the container image defined by the `plugin_config_uri` field.
+          "pluginConfigUri": "A String", # URI of the WasmPlugin configuration stored in the Artifact Registry. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. The container image must contain only a single file with the name `plugin.config`. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `plugin_config_digest` field.
+          "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+        },
+      },
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the parameters of the specified `WasmPlugin` resource.
+
+Args:
+  name: string, Identifier. Name of the `WasmPlugin` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `WasmPlugin` is a resource representing a service executing a customer-provided Wasm module.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A human-readable description of the resource.
+  "labels": { # Optional. Set of labels associated with the `WasmPlugin` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).
+    "a_key": "A String",
+  },
+  "logConfig": { # Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging. # Optional. Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging. Note that the settings relate to the logs generated by using logging statements in your Wasm code.
+    "enable": True or False, # Optional. Specifies whether to enable logging for activity by this `WasmPlugin`. Defaults to `false`.
+    "minLogLevel": "A String", # Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the `WasmPlugin` resource. If the field is not provided when logging is enabled, it is set to `INFO` by default.
+    "sampleRate": 3.14, # Non-empty default. Configures the sampling rate of activity logs, where `1.0` means all logged activity is reported and `0.0` means no activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must be between `0` and `1` (inclusive). This field can only be specified if logging is enabled for this `WasmPlugin`.
+  },
+  "mainVersionId": "A String", # Optional. The ID of the `WasmPluginVersion` resource that is the currently serving one. The version referred to must be a child of this `WasmPlugin` resource.
+  "name": "A String", # Identifier. Name of the `WasmPlugin` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}`.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+  "usedBy": [ # Output only. List of all [Service Extensions](https://cloud.google.com/service-extensions/docs/overview) that use this `WasmPlugin`.
+    { # Defines a resource that uses the `WasmPlugin`.
+      "name": "A String", # Output only. Full name of the resource https://google.aip.dev/122#full-resource-names, e.g. `//networkservices.googleapis.com/projects/{project}/locations/{location}/lbRouteExtensions/{extension}`
+    },
+  ],
+  "versions": { # Optional. All versions of this `WasmPlugin` in the key-value format. The key is the resource ID, the value is the `VersionDetails`. Allows to create or update `WasmPlugin` and its WasmPluginVersions in a single request. When the `main_version_id` field is not empty it must point to one of the VersionDetails in the map. If provided in the update request, the new versions replace the previous set. Any version omitted from the `versions` will be removed. Since the `WasmPluginVersion` resource is immutable, if the WasmPluginVersion with the same name already exists and differs the Update request will fail. Note: In the GET request, this field is populated only if the GetWasmPluginRequest.view is set to WASM_PLUGIN_VIEW_FULL.
+    "a_key": { # Details of a `WasmPluginVersion` resource to be inlined in the `WasmPlugin` resource.
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "description": "A String", # Optional. A human-readable description of the resource.
+      "imageDigest": "A String", # Output only. The resolved digest for the image specified in `image`. The digest is resolved during the creation of a `WasmPluginVersion` resource. This field holds the digest value regardless of whether a tag or digest was originally specified in the `image` field.
+      "imageUri": "A String", # Optional. URI of the container image containing the Wasm module, stored in the Artifact Registry. The container image must contain only a single file with the name `plugin.wasm`. When a new `WasmPluginVersion` resource is created, the URI gets resolved to an image digest and saved in the `image_digest` field.
+      "labels": { # Optional. Set of labels associated with the `WasmPluginVersion` resource.
+        "a_key": "A String",
+      },
+      "pluginConfigData": "A String", # Configuration for the Wasm plugin. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When a new `WasmPluginVersion` version is created, the digest of the contents is saved in the `plugin_config_digest` field.
+      "pluginConfigDigest": "A String", # Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of the `plugin_config_data` or the container image defined by the `plugin_config_uri` field.
+      "pluginConfigUri": "A String", # URI of the WasmPlugin configuration stored in the Artifact Registry. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. The container image must contain only a single file with the name `plugin.config`. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `plugin_config_digest` field.
+      "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+    },
+  },
+}
+
+  updateMask: string, Optional. Used to specify the fields to be overwritten in the `WasmPlugin` resource by the update. The fields specified in the `update_mask` field are relative to the resource, not the full request. An omitted `update_mask` field is treated as an implied `update_mask` field equivalent to all fields that are populated (that have a non-empty value). The `update_mask` field supports a special value `*`, which means that each field in the given `WasmPlugin` resource (including the empty ones) replaces the current value.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.wasmPlugins.versions.html b/docs/dyn/networkservices_v1beta1.projects.locations.wasmPlugins.versions.html new file mode 100644 index 0000000000..d0ee4e45d1 --- /dev/null +++ b/docs/dyn/networkservices_v1beta1.projects.locations.wasmPlugins.versions.html @@ -0,0 +1,271 @@ + + + +

Network Services API . projects . locations . wasmPlugins . versions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new `WasmPluginVersion` resource in a given project and location.

+

+ delete(name, x__xgafv=None)

+

Deletes the specified `WasmPluginVersion` resource.

+

+ get(name, x__xgafv=None)

+

Gets details of the specified `WasmPluginVersion` resource.

+

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

+

Lists `WasmPluginVersion` resources in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, wasmPluginVersionId=None, x__xgafv=None) +
Creates a new `WasmPluginVersion` resource in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource of the `WasmPluginVersion` resource. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single immutable version of a `WasmPlugin`. Defines the Wasm module used and optionally its runtime config.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A human-readable description of the resource.
+  "imageDigest": "A String", # Output only. The resolved digest for the image specified in `image`. The digest is resolved during the creation of `WasmPluginVersion` resource. This field holds the digest value regardless of whether a tag or digest was originally specified in the `image` field.
+  "imageUri": "A String", # Optional. URI of the container image containing the Wasm plugin, stored in the Artifact Registry. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `image_digest` field. When downloading an image, the digest value is used instead of an image tag.
+  "labels": { # Optional. Set of labels associated with the `WasmPluginVersion` resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the `WasmPluginVersion` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}/ versions/{wasm_plugin_version}`.
+  "pluginConfigData": "A String", # Configuration for the Wasm plugin. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When a new `WasmPluginVersion` resource is created, the digest of the contents is saved in the `plugin_config_digest` field.
+  "pluginConfigDigest": "A String", # Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of the `plugin_config_data` or the container image defined by the `plugin_config_uri` field.
+  "pluginConfigUri": "A String", # URI of the Wasm plugin configuration stored in the Artifact Registry. The configuration is provided to the plugin at runtime through the `ON_CONFIGURE` callback. The container image must contain only a single file with the name `plugin.config`. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `plugin_config_digest` field.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}
+
+  wasmPluginVersionId: string, Required. User-provided ID of the `WasmPluginVersion` resource to be created.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes the specified `WasmPluginVersion` resource.
+
+Args:
+  name: string, Required. A name of the `WasmPluginVersion` resource to delete. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}/versions/{wasm_plugin_version}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets details of the specified `WasmPluginVersion` resource.
+
+Args:
+  name: string, Required. A name of the `WasmPluginVersion` resource to get. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}/versions/{wasm_plugin_version}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single immutable version of a `WasmPlugin`. Defines the Wasm module used and optionally its runtime config.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A human-readable description of the resource.
+  "imageDigest": "A String", # Output only. The resolved digest for the image specified in `image`. The digest is resolved during the creation of `WasmPluginVersion` resource. This field holds the digest value regardless of whether a tag or digest was originally specified in the `image` field.
+  "imageUri": "A String", # Optional. URI of the container image containing the Wasm plugin, stored in the Artifact Registry. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `image_digest` field. When downloading an image, the digest value is used instead of an image tag.
+  "labels": { # Optional. Set of labels associated with the `WasmPluginVersion` resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the `WasmPluginVersion` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}/ versions/{wasm_plugin_version}`.
+  "pluginConfigData": "A String", # Configuration for the Wasm plugin. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When a new `WasmPluginVersion` resource is created, the digest of the contents is saved in the `plugin_config_digest` field.
+  "pluginConfigDigest": "A String", # Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of the `plugin_config_data` or the container image defined by the `plugin_config_uri` field.
+  "pluginConfigUri": "A String", # URI of the Wasm plugin configuration stored in the Artifact Registry. The configuration is provided to the plugin at runtime through the `ON_CONFIGURE` callback. The container image must contain only a single file with the name `plugin.config`. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `plugin_config_digest` field.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists `WasmPluginVersion` resources in a given project and location.
+
+Args:
+  parent: string, Required. The `WasmPlugin` resource whose `WasmPluginVersion`s are listed, specified in the following format: `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`. (required)
+  pageSize: integer, Maximum number of `WasmPluginVersion` resources to return per call. If not specified, at most 50 `WasmPluginVersion`s are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
+  pageToken: string, The value returned by the last `ListWasmPluginVersionsResponse` call. Indicates that this is a continuation of a prior `ListWasmPluginVersions` call, and that the next page of data is to be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response returned by the `ListWasmPluginVersions` method.
+  "nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
+  "wasmPluginVersions": [ # List of `WasmPluginVersion` resources.
+    { # A single immutable version of a `WasmPlugin`. Defines the Wasm module used and optionally its runtime config.
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "description": "A String", # Optional. A human-readable description of the resource.
+      "imageDigest": "A String", # Output only. The resolved digest for the image specified in `image`. The digest is resolved during the creation of `WasmPluginVersion` resource. This field holds the digest value regardless of whether a tag or digest was originally specified in the `image` field.
+      "imageUri": "A String", # Optional. URI of the container image containing the Wasm plugin, stored in the Artifact Registry. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `image_digest` field. When downloading an image, the digest value is used instead of an image tag.
+      "labels": { # Optional. Set of labels associated with the `WasmPluginVersion` resource.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. Name of the `WasmPluginVersion` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}/ versions/{wasm_plugin_version}`.
+      "pluginConfigData": "A String", # Configuration for the Wasm plugin. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When a new `WasmPluginVersion` resource is created, the digest of the contents is saved in the `plugin_config_digest` field.
+      "pluginConfigDigest": "A String", # Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of the `plugin_config_data` or the container image defined by the `plugin_config_uri` field.
+      "pluginConfigUri": "A String", # URI of the Wasm plugin configuration stored in the Artifact Registry. The configuration is provided to the plugin at runtime through the `ON_CONFIGURE` callback. The container image must contain only a single file with the name `plugin.config`. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `plugin_config_digest` field.
+      "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/notebooks_v1.projects.locations.instances.html b/docs/dyn/notebooks_v1.projects.locations.instances.html index 02cd51bdaf..d93bf1f1d7 100644 --- a/docs/dyn/notebooks_v1.projects.locations.instances.html +++ b/docs/dyn/notebooks_v1.projects.locations.instances.html @@ -367,7 +367,7 @@

Method Details

"relativePath": "A String", # Optional. Defines the relative storage path in the Cloud Storage bucket where the diagnostic logs will be written: Default path will be the root directory of the Cloud Storage bucket (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`) Example of full path where Log file will be written: `gs://$GCS_BUCKET/$RELATIVE_PATH/` "repairFlagEnabled": True or False, # Optional. Enables flag to repair service for instance }, - "timeoutMinutes": 42, # Optional. Maxmium amount of time in minutes before the operation times out. + "timeoutMinutes": 42, # Optional. Maximum amount of time in minutes before the operation times out. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/notebooks_v1.projects.locations.runtimes.html b/docs/dyn/notebooks_v1.projects.locations.runtimes.html index 24feced962..3472beda65 100644 --- a/docs/dyn/notebooks_v1.projects.locations.runtimes.html +++ b/docs/dyn/notebooks_v1.projects.locations.runtimes.html @@ -353,7 +353,7 @@

Method Details

"relativePath": "A String", # Optional. Defines the relative storage path in the Cloud Storage bucket where the diagnostic logs will be written: Default path will be the root directory of the Cloud Storage bucket (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`) Example of full path where Log file will be written: `gs://$GCS_BUCKET/$RELATIVE_PATH/` "repairFlagEnabled": True or False, # Optional. Enables flag to repair service for instance }, - "timeoutMinutes": 42, # Optional. Maxmium amount of time in minutes before the operation times out. + "timeoutMinutes": 42, # Optional. Maximum amount of time in minutes before the operation times out. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/notebooks_v2.projects.locations.instances.html b/docs/dyn/notebooks_v2.projects.locations.instances.html index d19037b93b..fdc8ef5759 100644 --- a/docs/dyn/notebooks_v2.projects.locations.instances.html +++ b/docs/dyn/notebooks_v2.projects.locations.instances.html @@ -368,7 +368,7 @@

Method Details

"gcsBucket": "A String", # Required. User Cloud Storage bucket location (REQUIRED). Must be formatted with path prefix (`gs://$GCS_BUCKET`). Permissions: User Managed Notebooks: - storage.buckets.writer: Must be given to the project's service account attached to VM. Google Managed Notebooks: - storage.buckets.writer: Must be given to the project's service account or user credentials attached to VM depending on authentication mode. Cloud Storage bucket Log file will be written to `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz` "relativePath": "A String", # Optional. Defines the relative storage path in the Cloud Storage bucket where the diagnostic logs will be written: Default path will be the root directory of the Cloud Storage bucket (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`) Example of full path where Log file will be written: `gs://$GCS_BUCKET/$RELATIVE_PATH/` }, - "timeoutMinutes": 42, # Optional. Maxmium amount of time in minutes before the operation times out. + "timeoutMinutes": 42, # Optional. Maximum amount of time in minutes before the operation times out. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/oracledatabase_v1.projects.locations.cloudExadataInfrastructures.html b/docs/dyn/oracledatabase_v1.projects.locations.cloudExadataInfrastructures.html index 63ff8f7536..3aca696ca7 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.cloudExadataInfrastructures.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.cloudExadataInfrastructures.html @@ -126,14 +126,14 @@

Method Details

"additionalStorageCount": 42, # Output only. The requested number of additional storage servers for the Exadata Infrastructure. "availableStorageSizeGb": 42, # Output only. The available storage can be allocated to the Exadata Infrastructure resource, in gigabytes (GB). "computeCount": 42, # Optional. The number of compute servers for the Exadata Infrastructure. - "cpuCount": 42, # Optional. The number of enabled CPU cores. + "cpuCount": 42, # Output only. The number of enabled CPU cores. "customerContacts": [ # Optional. The list of customer contacts. { # The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact "email": "A String", # Required. The email address used by Oracle to send notifications regarding databases and infrastructure. }, ], "dataStorageSizeTb": 3.14, # Output only. Size, in terabytes, of the DATA disk group. - "dbNodeStorageSizeGb": 42, # Optional. The local node storage allocated in GBs. + "dbNodeStorageSizeGb": 42, # Output only. The local node storage allocated in GBs. "dbServerVersion": "A String", # Output only. The software version of the database servers (dom0) in the Exadata Infrastructure. "maintenanceWindow": { # Maintenance window as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/MaintenanceWindow # Optional. Maintenance window for repair. "customActionTimeoutMins": 42, # Optional. Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). @@ -158,7 +158,7 @@

Method Details

"maxDataStorageTb": 3.14, # Output only. The total available DATA disk group size. "maxDbNodeStorageSizeGb": 42, # Output only. The total local node storage available in GBs. "maxMemoryGb": 42, # Output only. The total memory available in GBs. - "memorySizeGb": 42, # Optional. The memory allocated in GBs. + "memorySizeGb": 42, # Output only. The memory allocated in GBs. "monthlyDbServerVersion": "A String", # Output only. The monthly software version of the database servers (dom0) in the Exadata Infrastructure. Example: 20.1.15 "monthlyStorageServerVersion": "A String", # Output only. The monthly software version of the storage servers (cells) in the Exadata Infrastructure. Example: 20.1.15 "nextMaintenanceRunId": "A String", # Output only. The OCID of the next maintenance run. @@ -270,14 +270,14 @@

Method Details

"additionalStorageCount": 42, # Output only. The requested number of additional storage servers for the Exadata Infrastructure. "availableStorageSizeGb": 42, # Output only. The available storage can be allocated to the Exadata Infrastructure resource, in gigabytes (GB). "computeCount": 42, # Optional. The number of compute servers for the Exadata Infrastructure. - "cpuCount": 42, # Optional. The number of enabled CPU cores. + "cpuCount": 42, # Output only. The number of enabled CPU cores. "customerContacts": [ # Optional. The list of customer contacts. { # The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact "email": "A String", # Required. The email address used by Oracle to send notifications regarding databases and infrastructure. }, ], "dataStorageSizeTb": 3.14, # Output only. Size, in terabytes, of the DATA disk group. - "dbNodeStorageSizeGb": 42, # Optional. The local node storage allocated in GBs. + "dbNodeStorageSizeGb": 42, # Output only. The local node storage allocated in GBs. "dbServerVersion": "A String", # Output only. The software version of the database servers (dom0) in the Exadata Infrastructure. "maintenanceWindow": { # Maintenance window as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/MaintenanceWindow # Optional. Maintenance window for repair. "customActionTimeoutMins": 42, # Optional. Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). @@ -302,7 +302,7 @@

Method Details

"maxDataStorageTb": 3.14, # Output only. The total available DATA disk group size. "maxDbNodeStorageSizeGb": 42, # Output only. The total local node storage available in GBs. "maxMemoryGb": 42, # Output only. The total memory available in GBs. - "memorySizeGb": 42, # Optional. The memory allocated in GBs. + "memorySizeGb": 42, # Output only. The memory allocated in GBs. "monthlyDbServerVersion": "A String", # Output only. The monthly software version of the database servers (dom0) in the Exadata Infrastructure. Example: 20.1.15 "monthlyStorageServerVersion": "A String", # Output only. The monthly software version of the storage servers (cells) in the Exadata Infrastructure. Example: 20.1.15 "nextMaintenanceRunId": "A String", # Output only. The OCID of the next maintenance run. @@ -351,14 +351,14 @@

Method Details

"additionalStorageCount": 42, # Output only. The requested number of additional storage servers for the Exadata Infrastructure. "availableStorageSizeGb": 42, # Output only. The available storage can be allocated to the Exadata Infrastructure resource, in gigabytes (GB). "computeCount": 42, # Optional. The number of compute servers for the Exadata Infrastructure. - "cpuCount": 42, # Optional. The number of enabled CPU cores. + "cpuCount": 42, # Output only. The number of enabled CPU cores. "customerContacts": [ # Optional. The list of customer contacts. { # The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact "email": "A String", # Required. The email address used by Oracle to send notifications regarding databases and infrastructure. }, ], "dataStorageSizeTb": 3.14, # Output only. Size, in terabytes, of the DATA disk group. - "dbNodeStorageSizeGb": 42, # Optional. The local node storage allocated in GBs. + "dbNodeStorageSizeGb": 42, # Output only. The local node storage allocated in GBs. "dbServerVersion": "A String", # Output only. The software version of the database servers (dom0) in the Exadata Infrastructure. "maintenanceWindow": { # Maintenance window as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/MaintenanceWindow # Optional. Maintenance window for repair. "customActionTimeoutMins": 42, # Optional. Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). @@ -383,7 +383,7 @@

Method Details

"maxDataStorageTb": 3.14, # Output only. The total available DATA disk group size. "maxDbNodeStorageSizeGb": 42, # Output only. The total local node storage available in GBs. "maxMemoryGb": 42, # Output only. The total memory available in GBs. - "memorySizeGb": 42, # Optional. The memory allocated in GBs. + "memorySizeGb": 42, # Output only. The memory allocated in GBs. "monthlyDbServerVersion": "A String", # Output only. The monthly software version of the database servers (dom0) in the Exadata Infrastructure. Example: 20.1.15 "monthlyStorageServerVersion": "A String", # Output only. The monthly software version of the storage servers (cells) in the Exadata Infrastructure. Example: 20.1.15 "nextMaintenanceRunId": "A String", # Output only. The OCID of the next maintenance run. diff --git a/docs/dyn/orgpolicy_v2.folders.constraints.html b/docs/dyn/orgpolicy_v2.folders.constraints.html index d8979b8b99..30a8c023f6 100644 --- a/docs/dyn/orgpolicy_v2.folders.constraints.html +++ b/docs/dyn/orgpolicy_v2.folders.constraints.html @@ -109,6 +109,27 @@

Method Details

"constraints": [ # The collection of constraints that are available on the targeted resource. { # A constraint describes a way to restrict resource's configuration. For example, you could enforce a constraint that controls which Google Cloud services can be activated across an organization, or whether a Compute Engine instance can have serial port connections established. Constraints can be configured by the organization policy administrator to fit the needs of the organization by setting a policy that includes constraints at different locations in the organization's resource hierarchy. Policies are inherited down the resource hierarchy from higher levels, but can also be overridden. For details about the inheritance rules please read about `policies`. Constraints have a default behavior determined by the `constraint_default` field, which is the enforcement behavior that is used in the absence of a policy being defined or inherited for the resource in question. "booleanConstraint": { # A constraint that is either enforced or not. For example, a constraint `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM instance, serial port connections will not be opened to that instance. # Defines this constraint as being a BooleanConstraint. + "customConstraintDefinition": { # Currently used for Managed Constraints. This represents a subset of fields missing from Constraint proto that are required to describe CustomConstraint # Custom constraint definition. This is set only for Managed Constraints + "actionType": "A String", # Allow or deny type. + "condition": "A String", # Org policy condition/expression. For example: `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. + "methodTypes": [ # All the operations being applied for this constraint. + "A String", + ], + "parameters": { # Stores Structure of parameters used by Constraint condition. Key of map represents name of the parameter. + "a_key": { # Defines a parameter structure. + "defaultValue": "", # Sets the value of the parameter in an assignment if no value is given. + "item": "A String", # Determines the parameter’s value structure. For example, LIST can be specified by defining type : LIST, and item type as : STRING. + "metadata": { # Defines Medata structure. # Defines subproperties primarily used by the UI to display user-friendly information. + "description": "A String", # Detailed description of what this `parameter` is and use of it. Mutable. + }, + "type": "A String", # Type of the parameter. + "validValuesExpr": "A String", # Provides a CEL expression to specify the acceptable parameter values during assignment. For example, parameterName in ("parameterValue1", "parameterValue2") + }, + }, + "resourceTypes": [ # The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. + "A String", + ], + }, }, "constraintDefault": "A String", # The evaluation behavior of this constraint in the absence of a policy. "description": "A String", # Detailed description of what this constraint controls as well as how and where it is enforced. Mutable. diff --git a/docs/dyn/orgpolicy_v2.organizations.constraints.html b/docs/dyn/orgpolicy_v2.organizations.constraints.html index 11d8b46853..1a06118eac 100644 --- a/docs/dyn/orgpolicy_v2.organizations.constraints.html +++ b/docs/dyn/orgpolicy_v2.organizations.constraints.html @@ -109,6 +109,27 @@

Method Details

"constraints": [ # The collection of constraints that are available on the targeted resource. { # A constraint describes a way to restrict resource's configuration. For example, you could enforce a constraint that controls which Google Cloud services can be activated across an organization, or whether a Compute Engine instance can have serial port connections established. Constraints can be configured by the organization policy administrator to fit the needs of the organization by setting a policy that includes constraints at different locations in the organization's resource hierarchy. Policies are inherited down the resource hierarchy from higher levels, but can also be overridden. For details about the inheritance rules please read about `policies`. Constraints have a default behavior determined by the `constraint_default` field, which is the enforcement behavior that is used in the absence of a policy being defined or inherited for the resource in question. "booleanConstraint": { # A constraint that is either enforced or not. For example, a constraint `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM instance, serial port connections will not be opened to that instance. # Defines this constraint as being a BooleanConstraint. + "customConstraintDefinition": { # Currently used for Managed Constraints. This represents a subset of fields missing from Constraint proto that are required to describe CustomConstraint # Custom constraint definition. This is set only for Managed Constraints + "actionType": "A String", # Allow or deny type. + "condition": "A String", # Org policy condition/expression. For example: `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. + "methodTypes": [ # All the operations being applied for this constraint. + "A String", + ], + "parameters": { # Stores Structure of parameters used by Constraint condition. Key of map represents name of the parameter. + "a_key": { # Defines a parameter structure. + "defaultValue": "", # Sets the value of the parameter in an assignment if no value is given. + "item": "A String", # Determines the parameter’s value structure. For example, LIST can be specified by defining type : LIST, and item type as : STRING. + "metadata": { # Defines Medata structure. # Defines subproperties primarily used by the UI to display user-friendly information. + "description": "A String", # Detailed description of what this `parameter` is and use of it. Mutable. + }, + "type": "A String", # Type of the parameter. + "validValuesExpr": "A String", # Provides a CEL expression to specify the acceptable parameter values during assignment. For example, parameterName in ("parameterValue1", "parameterValue2") + }, + }, + "resourceTypes": [ # The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. + "A String", + ], + }, }, "constraintDefault": "A String", # The evaluation behavior of this constraint in the absence of a policy. "description": "A String", # Detailed description of what this constraint controls as well as how and where it is enforced. Mutable. diff --git a/docs/dyn/orgpolicy_v2.projects.constraints.html b/docs/dyn/orgpolicy_v2.projects.constraints.html index fc9b70a64d..cb89317d60 100644 --- a/docs/dyn/orgpolicy_v2.projects.constraints.html +++ b/docs/dyn/orgpolicy_v2.projects.constraints.html @@ -109,6 +109,27 @@

Method Details

"constraints": [ # The collection of constraints that are available on the targeted resource. { # A constraint describes a way to restrict resource's configuration. For example, you could enforce a constraint that controls which Google Cloud services can be activated across an organization, or whether a Compute Engine instance can have serial port connections established. Constraints can be configured by the organization policy administrator to fit the needs of the organization by setting a policy that includes constraints at different locations in the organization's resource hierarchy. Policies are inherited down the resource hierarchy from higher levels, but can also be overridden. For details about the inheritance rules please read about `policies`. Constraints have a default behavior determined by the `constraint_default` field, which is the enforcement behavior that is used in the absence of a policy being defined or inherited for the resource in question. "booleanConstraint": { # A constraint that is either enforced or not. For example, a constraint `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM instance, serial port connections will not be opened to that instance. # Defines this constraint as being a BooleanConstraint. + "customConstraintDefinition": { # Currently used for Managed Constraints. This represents a subset of fields missing from Constraint proto that are required to describe CustomConstraint # Custom constraint definition. This is set only for Managed Constraints + "actionType": "A String", # Allow or deny type. + "condition": "A String", # Org policy condition/expression. For example: `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. + "methodTypes": [ # All the operations being applied for this constraint. + "A String", + ], + "parameters": { # Stores Structure of parameters used by Constraint condition. Key of map represents name of the parameter. + "a_key": { # Defines a parameter structure. + "defaultValue": "", # Sets the value of the parameter in an assignment if no value is given. + "item": "A String", # Determines the parameter’s value structure. For example, LIST can be specified by defining type : LIST, and item type as : STRING. + "metadata": { # Defines Medata structure. # Defines subproperties primarily used by the UI to display user-friendly information. + "description": "A String", # Detailed description of what this `parameter` is and use of it. Mutable. + }, + "type": "A String", # Type of the parameter. + "validValuesExpr": "A String", # Provides a CEL expression to specify the acceptable parameter values during assignment. For example, parameterName in ("parameterValue1", "parameterValue2") + }, + }, + "resourceTypes": [ # The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. + "A String", + ], + }, }, "constraintDefault": "A String", # The evaluation behavior of this constraint in the absence of a policy. "description": "A String", # Detailed description of what this constraint controls as well as how and where it is enforced. Mutable. diff --git a/docs/dyn/places_v1.places.html b/docs/dyn/places_v1.places.html index 0c77e23ef7..d25e23bd50 100644 --- a/docs/dyn/places_v1.places.html +++ b/docs/dyn/places_v1.places.html @@ -286,6 +286,35 @@

Method Details

], }, ], + "addressDescriptor": { # A relational description of a location. Includes a ranked set of nearby landmarks and precise containing areas and their relationship to the target location. # The address descriptor of the place. Address descriptors include additional information that help describe a location using landmarks and areas. See address descriptor regional coverage in https://developers.google.com/maps/documentation/geocoding/address-descriptors/coverage. + "areas": [ # A ranked list of containing or adjacent areas. The most recognizable and precise areas are ranked first. + { # Area information and the area's relationship with the target location. Areas includes precise sublocality, neighborhoods, and large compounds that are useful for describing a location. + "containment": "A String", # Defines the spatial relationship between the target location and the area. + "displayName": { # Localized variant of a text in a particular language. # The area's display name. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "name": "A String", # The area's resource name. + "placeId": "A String", # The area's place id. + }, + ], + "landmarks": [ # A ranked list of nearby landmarks. The most recognizable and nearby landmarks are ranked first. + { # Basic landmark information and the landmark's relationship with the target location. Landmarks are prominent places that can be used to describe a location. + "displayName": { # Localized variant of a text in a particular language. # The landmark's display name. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "name": "A String", # The landmark's resource name. + "placeId": "A String", # The landmark's place id. + "spatialRelationship": "A String", # Defines the spatial relationship between the target location and the landmark. + "straightLineDistanceMeters": 3.14, # The straight line distance, in meters, between the center point of the target and the center point of the landmark. In some situations, this value can be longer than `travel_distance_meters`. + "travelDistanceMeters": 3.14, # The travel distance, in meters, along the road network from the target to the landmark, if known. This value does not take into account the mode of transportation, such as walking, driving, or biking. + "types": [ # A set of type tags for this landmark. For a complete list of possible values, see https://developers.google.com/maps/documentation/places/web-service/place-types. + "A String", + ], + }, + ], + }, "adrFormatAddress": "A String", # The place's address in adr microformat: http://microformats.org/wiki/adr. "allowsDogs": True or False, # Place allows dogs. "areaSummary": { # Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. AI-generated summary of the area that the place is in. # Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. AI-generated summary of the area that the place is in. @@ -681,7 +710,7 @@

Method Details

], "userRatingCount": 42, # The total number of reviews (with or without text) for this place. "utcOffsetMinutes": 42, # Number of minutes this place's timezone is currently offset from UTC. This is expressed in minutes to support timezones that are offset by fractions of an hour, e.g. X hours and 15 minutes. - "viewport": { # A latitude-longitude viewport, represented as two diagonally opposite `low` and `high` points. A viewport is considered a closed region, i.e. it includes its boundary. The latitude bounds must range between -90 to 90 degrees inclusive, and the longitude bounds must range between -180 to 180 degrees inclusive. Various cases include: - If `low` = `high`, the viewport consists of that single point. - If `low.longitude` > `high.longitude`, the longitude range is inverted (the viewport crosses the 180 degree longitude line). - If `low.longitude` = -180 degrees and `high.longitude` = 180 degrees, the viewport includes all longitudes. - If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, the longitude range is empty. - If `low.latitude` > `high.latitude`, the latitude range is empty. Both `low` and `high` must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error. For example, this viewport fully encloses New York City: { "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } } # A viewport suitable for displaying the place on an average-sized map. + "viewport": { # A latitude-longitude viewport, represented as two diagonally opposite `low` and `high` points. A viewport is considered a closed region, i.e. it includes its boundary. The latitude bounds must range between -90 to 90 degrees inclusive, and the longitude bounds must range between -180 to 180 degrees inclusive. Various cases include: - If `low` = `high`, the viewport consists of that single point. - If `low.longitude` > `high.longitude`, the longitude range is inverted (the viewport crosses the 180 degree longitude line). - If `low.longitude` = -180 degrees and `high.longitude` = 180 degrees, the viewport includes all longitudes. - If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, the longitude range is empty. - If `low.latitude` > `high.latitude`, the latitude range is empty. Both `low` and `high` must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error. For example, this viewport fully encloses New York City: { "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } } # A viewport suitable for displaying the place on an average-sized map. This viewport should not be used as the physical boundary or the service area of the business. "high": { # 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. # Required. The high point of the viewport. "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]. @@ -772,6 +801,35 @@

Method Details

], }, ], + "addressDescriptor": { # A relational description of a location. Includes a ranked set of nearby landmarks and precise containing areas and their relationship to the target location. # The address descriptor of the place. Address descriptors include additional information that help describe a location using landmarks and areas. See address descriptor regional coverage in https://developers.google.com/maps/documentation/geocoding/address-descriptors/coverage. + "areas": [ # A ranked list of containing or adjacent areas. The most recognizable and precise areas are ranked first. + { # Area information and the area's relationship with the target location. Areas includes precise sublocality, neighborhoods, and large compounds that are useful for describing a location. + "containment": "A String", # Defines the spatial relationship between the target location and the area. + "displayName": { # Localized variant of a text in a particular language. # The area's display name. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "name": "A String", # The area's resource name. + "placeId": "A String", # The area's place id. + }, + ], + "landmarks": [ # A ranked list of nearby landmarks. The most recognizable and nearby landmarks are ranked first. + { # Basic landmark information and the landmark's relationship with the target location. Landmarks are prominent places that can be used to describe a location. + "displayName": { # Localized variant of a text in a particular language. # The landmark's display name. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "name": "A String", # The landmark's resource name. + "placeId": "A String", # The landmark's place id. + "spatialRelationship": "A String", # Defines the spatial relationship between the target location and the landmark. + "straightLineDistanceMeters": 3.14, # The straight line distance, in meters, between the center point of the target and the center point of the landmark. In some situations, this value can be longer than `travel_distance_meters`. + "travelDistanceMeters": 3.14, # The travel distance, in meters, along the road network from the target to the landmark, if known. This value does not take into account the mode of transportation, such as walking, driving, or biking. + "types": [ # A set of type tags for this landmark. For a complete list of possible values, see https://developers.google.com/maps/documentation/places/web-service/place-types. + "A String", + ], + }, + ], + }, "adrFormatAddress": "A String", # The place's address in adr microformat: http://microformats.org/wiki/adr. "allowsDogs": True or False, # Place allows dogs. "areaSummary": { # Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. AI-generated summary of the area that the place is in. # Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. AI-generated summary of the area that the place is in. @@ -1167,7 +1225,7 @@

Method Details

], "userRatingCount": 42, # The total number of reviews (with or without text) for this place. "utcOffsetMinutes": 42, # Number of minutes this place's timezone is currently offset from UTC. This is expressed in minutes to support timezones that are offset by fractions of an hour, e.g. X hours and 15 minutes. - "viewport": { # A latitude-longitude viewport, represented as two diagonally opposite `low` and `high` points. A viewport is considered a closed region, i.e. it includes its boundary. The latitude bounds must range between -90 to 90 degrees inclusive, and the longitude bounds must range between -180 to 180 degrees inclusive. Various cases include: - If `low` = `high`, the viewport consists of that single point. - If `low.longitude` > `high.longitude`, the longitude range is inverted (the viewport crosses the 180 degree longitude line). - If `low.longitude` = -180 degrees and `high.longitude` = 180 degrees, the viewport includes all longitudes. - If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, the longitude range is empty. - If `low.latitude` > `high.latitude`, the latitude range is empty. Both `low` and `high` must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error. For example, this viewport fully encloses New York City: { "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } } # A viewport suitable for displaying the place on an average-sized map. + "viewport": { # A latitude-longitude viewport, represented as two diagonally opposite `low` and `high` points. A viewport is considered a closed region, i.e. it includes its boundary. The latitude bounds must range between -90 to 90 degrees inclusive, and the longitude bounds must range between -180 to 180 degrees inclusive. Various cases include: - If `low` = `high`, the viewport consists of that single point. - If `low.longitude` > `high.longitude`, the longitude range is inverted (the viewport crosses the 180 degree longitude line). - If `low.longitude` = -180 degrees and `high.longitude` = 180 degrees, the viewport includes all longitudes. - If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, the longitude range is empty. - If `low.latitude` > `high.latitude`, the latitude range is empty. Both `low` and `high` must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error. For example, this viewport fully encloses New York City: { "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } } # A viewport suitable for displaying the place on an average-sized map. This viewport should not be used as the physical boundary or the service area of the business. "high": { # 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. # Required. The high point of the viewport. "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]. @@ -1380,6 +1438,35 @@

Method Details

], }, ], + "addressDescriptor": { # A relational description of a location. Includes a ranked set of nearby landmarks and precise containing areas and their relationship to the target location. # The address descriptor of the place. Address descriptors include additional information that help describe a location using landmarks and areas. See address descriptor regional coverage in https://developers.google.com/maps/documentation/geocoding/address-descriptors/coverage. + "areas": [ # A ranked list of containing or adjacent areas. The most recognizable and precise areas are ranked first. + { # Area information and the area's relationship with the target location. Areas includes precise sublocality, neighborhoods, and large compounds that are useful for describing a location. + "containment": "A String", # Defines the spatial relationship between the target location and the area. + "displayName": { # Localized variant of a text in a particular language. # The area's display name. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "name": "A String", # The area's resource name. + "placeId": "A String", # The area's place id. + }, + ], + "landmarks": [ # A ranked list of nearby landmarks. The most recognizable and nearby landmarks are ranked first. + { # Basic landmark information and the landmark's relationship with the target location. Landmarks are prominent places that can be used to describe a location. + "displayName": { # Localized variant of a text in a particular language. # The landmark's display name. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "name": "A String", # The landmark's resource name. + "placeId": "A String", # The landmark's place id. + "spatialRelationship": "A String", # Defines the spatial relationship between the target location and the landmark. + "straightLineDistanceMeters": 3.14, # The straight line distance, in meters, between the center point of the target and the center point of the landmark. In some situations, this value can be longer than `travel_distance_meters`. + "travelDistanceMeters": 3.14, # The travel distance, in meters, along the road network from the target to the landmark, if known. This value does not take into account the mode of transportation, such as walking, driving, or biking. + "types": [ # A set of type tags for this landmark. For a complete list of possible values, see https://developers.google.com/maps/documentation/places/web-service/place-types. + "A String", + ], + }, + ], + }, "adrFormatAddress": "A String", # The place's address in adr microformat: http://microformats.org/wiki/adr. "allowsDogs": True or False, # Place allows dogs. "areaSummary": { # Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. AI-generated summary of the area that the place is in. # Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. AI-generated summary of the area that the place is in. @@ -1775,7 +1862,7 @@

Method Details

], "userRatingCount": 42, # The total number of reviews (with or without text) for this place. "utcOffsetMinutes": 42, # Number of minutes this place's timezone is currently offset from UTC. This is expressed in minutes to support timezones that are offset by fractions of an hour, e.g. X hours and 15 minutes. - "viewport": { # A latitude-longitude viewport, represented as two diagonally opposite `low` and `high` points. A viewport is considered a closed region, i.e. it includes its boundary. The latitude bounds must range between -90 to 90 degrees inclusive, and the longitude bounds must range between -180 to 180 degrees inclusive. Various cases include: - If `low` = `high`, the viewport consists of that single point. - If `low.longitude` > `high.longitude`, the longitude range is inverted (the viewport crosses the 180 degree longitude line). - If `low.longitude` = -180 degrees and `high.longitude` = 180 degrees, the viewport includes all longitudes. - If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, the longitude range is empty. - If `low.latitude` > `high.latitude`, the latitude range is empty. Both `low` and `high` must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error. For example, this viewport fully encloses New York City: { "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } } # A viewport suitable for displaying the place on an average-sized map. + "viewport": { # A latitude-longitude viewport, represented as two diagonally opposite `low` and `high` points. A viewport is considered a closed region, i.e. it includes its boundary. The latitude bounds must range between -90 to 90 degrees inclusive, and the longitude bounds must range between -180 to 180 degrees inclusive. Various cases include: - If `low` = `high`, the viewport consists of that single point. - If `low.longitude` > `high.longitude`, the longitude range is inverted (the viewport crosses the 180 degree longitude line). - If `low.longitude` = -180 degrees and `high.longitude` = 180 degrees, the viewport includes all longitudes. - If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, the longitude range is empty. - If `low.latitude` > `high.latitude`, the latitude range is empty. Both `low` and `high` must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error. For example, this viewport fully encloses New York City: { "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } } # A viewport suitable for displaying the place on an average-sized map. This viewport should not be used as the physical boundary or the service area of the business. "high": { # 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. # Required. The high point of the viewport. "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]. diff --git a/docs/dyn/readerrevenuesubscriptionlinking_v1.publications.readers.html b/docs/dyn/readerrevenuesubscriptionlinking_v1.publications.readers.html index 047a7132a4..eee3b17607 100644 --- a/docs/dyn/readerrevenuesubscriptionlinking_v1.publications.readers.html +++ b/docs/dyn/readerrevenuesubscriptionlinking_v1.publications.readers.html @@ -152,7 +152,7 @@

Method Details

"entitlements": [ # All of the entitlements for a publication reader. { # A single entitlement for a publication reader "detail": "A String", # The detail field can carry a description of the SKU that corresponds to what the user has been granted access to. This description, which is opaque to Google, can be displayed in the Google user subscription console for users who linked the subscription to a Google Account. Max 80 character limit. - "expireTime": "A String", # Required. Expiration time of the entitlement. Entitlements that have expired over 30 days will be purged. Required. LINT.IfChange(expire_time) The max expire_time is 398 days from now(). LINT.ThenChange(//depot/google3/java/com/google/subscribewithgoogle/accountlinking/subscriptionlink/service/config/protoconf.pi:max_expiry_age) + "expireTime": "A String", # Required. Expiration time of the entitlement. Entitlements that have expired over 30 days will be purged. The max expire_time is 398 days from now(). "productId": "A String", # Required. The publication's product ID that the user has access to. This is the same product ID as can be found in Schema.org markup (http://schema.org/productID). E.g. "dailybugle.com:basic" "subscriptionToken": "A String", # A source-specific subscription token. This is an opaque string that the publisher provides to Google. This token is opaque and has no meaning to Google. }, @@ -174,7 +174,7 @@

Method Details

"entitlements": [ # All of the entitlements for a publication reader. { # A single entitlement for a publication reader "detail": "A String", # The detail field can carry a description of the SKU that corresponds to what the user has been granted access to. This description, which is opaque to Google, can be displayed in the Google user subscription console for users who linked the subscription to a Google Account. Max 80 character limit. - "expireTime": "A String", # Required. Expiration time of the entitlement. Entitlements that have expired over 30 days will be purged. Required. LINT.IfChange(expire_time) The max expire_time is 398 days from now(). LINT.ThenChange(//depot/google3/java/com/google/subscribewithgoogle/accountlinking/subscriptionlink/service/config/protoconf.pi:max_expiry_age) + "expireTime": "A String", # Required. Expiration time of the entitlement. Entitlements that have expired over 30 days will be purged. The max expire_time is 398 days from now(). "productId": "A String", # Required. The publication's product ID that the user has access to. This is the same product ID as can be found in Schema.org markup (http://schema.org/productID). E.g. "dailybugle.com:basic" "subscriptionToken": "A String", # A source-specific subscription token. This is an opaque string that the publisher provides to Google. This token is opaque and has no meaning to Google. }, @@ -195,7 +195,7 @@

Method Details

"entitlements": [ # All of the entitlements for a publication reader. { # A single entitlement for a publication reader "detail": "A String", # The detail field can carry a description of the SKU that corresponds to what the user has been granted access to. This description, which is opaque to Google, can be displayed in the Google user subscription console for users who linked the subscription to a Google Account. Max 80 character limit. - "expireTime": "A String", # Required. Expiration time of the entitlement. Entitlements that have expired over 30 days will be purged. Required. LINT.IfChange(expire_time) The max expire_time is 398 days from now(). LINT.ThenChange(//depot/google3/java/com/google/subscribewithgoogle/accountlinking/subscriptionlink/service/config/protoconf.pi:max_expiry_age) + "expireTime": "A String", # Required. Expiration time of the entitlement. Entitlements that have expired over 30 days will be purged. The max expire_time is 398 days from now(). "productId": "A String", # Required. The publication's product ID that the user has access to. This is the same product ID as can be found in Schema.org markup (http://schema.org/productID). E.g. "dailybugle.com:basic" "subscriptionToken": "A String", # A source-specific subscription token. This is an opaque string that the publisher provides to Google. This token is opaque and has no meaning to Google. }, diff --git a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html index e0e244df17..0b598a8c02 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html @@ -323,6 +323,7 @@

Method Details

"reencryptedUserCredentialsHash": "A String", # Output only. Corresponds to the re-encryption of the `encrypted_user_credentials_hash` field. It is used to match potential password leaks within `encrypted_leak_match_prefixes`. }, "riskAnalysis": { # Risk analysis result for an event. # Output only. The risk analysis result for the event being assessed. + "challenge": "A String", # Output only. Challenge information for SCORE_AND_CHALLENGE keys "extendedVerdictReasons": [ # Output only. Extended verdict reasons to be used for experimentation only. The set of possible reasons is subject to change. "A String", ], @@ -539,6 +540,7 @@

Method Details

"reencryptedUserCredentialsHash": "A String", # Output only. Corresponds to the re-encryption of the `encrypted_user_credentials_hash` field. It is used to match potential password leaks within `encrypted_leak_match_prefixes`. }, "riskAnalysis": { # Risk analysis result for an event. # Output only. The risk analysis result for the event being assessed. + "challenge": "A String", # Output only. Challenge information for SCORE_AND_CHALLENGE keys "extendedVerdictReasons": [ # Output only. Extended verdict reasons to be used for experimentation only. The set of possible reasons is subject to change. "A String", ], diff --git a/docs/dyn/recommender_v1.billingAccounts.locations.recommenders.recommendations.html b/docs/dyn/recommender_v1.billingAccounts.locations.recommenders.recommendations.html index 9f0a2e84b3..fbb682e3a0 100644 --- a/docs/dyn/recommender_v1.billingAccounts.locations.recommenders.recommendations.html +++ b/docs/dyn/recommender_v1.billingAccounts.locations.recommenders.recommendations.html @@ -135,6 +135,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -148,6 +151,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -209,6 +213,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -222,6 +229,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -279,6 +287,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -292,6 +303,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -353,6 +365,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -366,6 +381,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -443,6 +459,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -456,6 +475,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -517,6 +537,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -530,6 +553,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -588,6 +612,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -601,6 +628,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -662,6 +690,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -675,6 +706,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -736,6 +768,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -749,6 +784,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -810,6 +846,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -823,6 +862,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -884,6 +924,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -897,6 +940,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -958,6 +1002,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -971,6 +1018,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). diff --git a/docs/dyn/recommender_v1.folders.locations.recommenders.recommendations.html b/docs/dyn/recommender_v1.folders.locations.recommenders.recommendations.html index 07b313e5c0..60684086b4 100644 --- a/docs/dyn/recommender_v1.folders.locations.recommenders.recommendations.html +++ b/docs/dyn/recommender_v1.folders.locations.recommenders.recommendations.html @@ -135,6 +135,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -148,6 +151,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -209,6 +213,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -222,6 +229,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -279,6 +287,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -292,6 +303,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -353,6 +365,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -366,6 +381,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -443,6 +459,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -456,6 +475,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -517,6 +537,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -530,6 +553,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -588,6 +612,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -601,6 +628,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -662,6 +690,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -675,6 +706,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -736,6 +768,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -749,6 +784,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -810,6 +846,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -823,6 +862,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -884,6 +924,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -897,6 +940,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -958,6 +1002,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -971,6 +1018,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). diff --git a/docs/dyn/recommender_v1.organizations.locations.recommenders.recommendations.html b/docs/dyn/recommender_v1.organizations.locations.recommenders.recommendations.html index b7d535bcab..756b034064 100644 --- a/docs/dyn/recommender_v1.organizations.locations.recommenders.recommendations.html +++ b/docs/dyn/recommender_v1.organizations.locations.recommenders.recommendations.html @@ -135,6 +135,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -148,6 +151,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -209,6 +213,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -222,6 +229,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -279,6 +287,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -292,6 +303,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -353,6 +365,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -366,6 +381,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -443,6 +459,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -456,6 +475,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -517,6 +537,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -530,6 +553,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -588,6 +612,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -601,6 +628,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -662,6 +690,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -675,6 +706,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -736,6 +768,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -749,6 +784,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -810,6 +846,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -823,6 +862,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -884,6 +924,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -897,6 +940,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -958,6 +1002,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -971,6 +1018,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). diff --git a/docs/dyn/recommender_v1.projects.locations.recommenders.recommendations.html b/docs/dyn/recommender_v1.projects.locations.recommenders.recommendations.html index 85bb26f2ac..1fad3c6c59 100644 --- a/docs/dyn/recommender_v1.projects.locations.recommenders.recommendations.html +++ b/docs/dyn/recommender_v1.projects.locations.recommenders.recommendations.html @@ -135,6 +135,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -148,6 +151,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -209,6 +213,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -222,6 +229,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -279,6 +287,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -292,6 +303,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -353,6 +365,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -366,6 +381,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -443,6 +459,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -456,6 +475,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -517,6 +537,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -530,6 +553,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -588,6 +612,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -601,6 +628,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -662,6 +690,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -675,6 +706,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -736,6 +768,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -749,6 +784,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -810,6 +846,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -823,6 +862,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -884,6 +924,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -897,6 +940,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -958,6 +1002,9 @@

Method Details

}, "duration": "A String", # Duration for which this cost applies. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -971,6 +1018,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustainability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). diff --git a/docs/dyn/recommender_v1beta1.billingAccounts.locations.recommenders.recommendations.html b/docs/dyn/recommender_v1beta1.billingAccounts.locations.recommenders.recommendations.html index cc0d8ff504..bfcb7775f5 100644 --- a/docs/dyn/recommender_v1beta1.billingAccounts.locations.recommenders.recommendations.html +++ b/docs/dyn/recommender_v1beta1.billingAccounts.locations.recommenders.recommendations.html @@ -136,6 +136,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -149,6 +152,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -211,6 +215,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -224,6 +231,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -282,6 +290,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -295,6 +306,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -357,6 +369,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -370,6 +385,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -448,6 +464,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -461,6 +480,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -523,6 +543,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -536,6 +559,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -595,6 +619,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -608,6 +635,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -670,6 +698,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -683,6 +714,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -745,6 +777,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -758,6 +793,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -820,6 +856,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -833,6 +872,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -895,6 +935,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -908,6 +951,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -970,6 +1014,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -983,6 +1030,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). diff --git a/docs/dyn/recommender_v1beta1.folders.locations.recommenders.recommendations.html b/docs/dyn/recommender_v1beta1.folders.locations.recommenders.recommendations.html index c1060b281f..b1970b86a3 100644 --- a/docs/dyn/recommender_v1beta1.folders.locations.recommenders.recommendations.html +++ b/docs/dyn/recommender_v1beta1.folders.locations.recommenders.recommendations.html @@ -136,6 +136,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -149,6 +152,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -211,6 +215,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -224,6 +231,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -282,6 +290,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -295,6 +306,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -357,6 +369,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -370,6 +385,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -448,6 +464,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -461,6 +480,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -523,6 +543,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -536,6 +559,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -595,6 +619,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -608,6 +635,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -670,6 +698,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -683,6 +714,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -745,6 +777,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -758,6 +793,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -820,6 +856,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -833,6 +872,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -895,6 +935,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -908,6 +951,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -970,6 +1014,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -983,6 +1030,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). diff --git a/docs/dyn/recommender_v1beta1.organizations.locations.recommenders.recommendations.html b/docs/dyn/recommender_v1beta1.organizations.locations.recommenders.recommendations.html index 2d1173ab1a..7b568bad2e 100644 --- a/docs/dyn/recommender_v1beta1.organizations.locations.recommenders.recommendations.html +++ b/docs/dyn/recommender_v1beta1.organizations.locations.recommenders.recommendations.html @@ -136,6 +136,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -149,6 +152,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -211,6 +215,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -224,6 +231,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -282,6 +290,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -295,6 +306,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -357,6 +369,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -370,6 +385,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -448,6 +464,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -461,6 +480,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -523,6 +543,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -536,6 +559,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -595,6 +619,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -608,6 +635,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -670,6 +698,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -683,6 +714,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -745,6 +777,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -758,6 +793,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -820,6 +856,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -833,6 +872,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -895,6 +935,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -908,6 +951,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -970,6 +1014,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -983,6 +1030,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). diff --git a/docs/dyn/recommender_v1beta1.projects.locations.recommenders.recommendations.html b/docs/dyn/recommender_v1beta1.projects.locations.recommenders.recommendations.html index accd97b7fe..ec31a646a4 100644 --- a/docs/dyn/recommender_v1beta1.projects.locations.recommenders.recommendations.html +++ b/docs/dyn/recommender_v1beta1.projects.locations.recommenders.recommendations.html @@ -136,6 +136,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -149,6 +152,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -211,6 +215,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -224,6 +231,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -282,6 +290,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -295,6 +306,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -357,6 +369,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -370,6 +385,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -448,6 +464,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -461,6 +480,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -523,6 +543,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -536,6 +559,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -595,6 +619,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -608,6 +635,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -670,6 +698,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -683,6 +714,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -745,6 +777,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -758,6 +793,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -820,6 +856,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -833,6 +872,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -895,6 +935,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -908,6 +951,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). @@ -970,6 +1014,9 @@

Method Details

"duration": "A String", # Duration for which this cost applies. "pricingType": "A String", # How the cost is calculated. }, + "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details. + # Object with schema name: GoogleCloudRecommenderV1beta1Impact + ], "reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY "details": { # Per-recommender projection. "a_key": "", # Properties of the object. @@ -983,6 +1030,7 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "service": "A String", # The service that this impact is associated with. "sustainabilityProjection": { # Contains metadata about how much sustainability a recommendation can save or incur. # Use with CategoryType.SUSTAINABILITY "duration": "A String", # Duration for which this sustanability applies. "kgCO2e": 3.14, # Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e). diff --git a/docs/dyn/redis_v1.projects.locations.clusters.html b/docs/dyn/redis_v1.projects.locations.clusters.html index 0d762ac467..3b06e386a5 100644 --- a/docs/dyn/redis_v1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1.projects.locations.clusters.html @@ -118,6 +118,24 @@

Method Details

{ # A cluster instance. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. + "clusterEndpoints": [ # Optional. A list of cluster enpoints. + { # ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster. + "connections": [ # A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. + { # Detailed information of each PSC connection. + "pscConnection": { # Details of consumer resources in a PSC connection. # Detailed information of a PSC connection that is created by the customer who owns the cluster. + "address": "A String", # Required. The IP allocated on the consumer network for the PSC forwarding rule. + "connectionType": "A String", # Output only. Type of the PSC connection. + "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. + "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. + "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. + "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. + "serviceAttachment": "A String", # Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. + }, + }, + ], + }, + ], "createTime": "A String", # Output only. The timestamp associated with the cluster creation request. "crossClusterReplicationConfig": { # Cross cluster replication config. # Optional. Cross cluster replication config. "clusterRole": "A String", # The role of the cluster in cross cluster replication. @@ -187,7 +205,7 @@

Method Details

}, }, "preciseSizeGb": 3.14, # Output only. Precise value of redis memory size in GB for the entire cluster. - "pscConfigs": [ # Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported. + "pscConfigs": [ # Optional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported. { "network": "A String", # Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{network_project}/global/networks/{network_id}. }, @@ -195,13 +213,21 @@

Method Details

"pscConnections": [ # Output only. The list of PSC connections that are auto-created through service connectivity automation. { # Details of consumer resources in a PSC connection. "address": "A String", # Required. The IP allocated on the consumer network for the PSC forwarding rule. + "connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. + "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. "serviceAttachment": "A String", # Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. }, ], + "pscServiceAttachments": [ # Output only. Service attachment details to configure Psc connections + { # Configuration of a service attachment of the cluster, for creating PSC connections. + "connectionType": "A String", # Output only. Type of a PSC connection targeting this service attachment. + "serviceAttachment": "A String", # Output only. Service attachment URI which your self-created PscConnection should use as target + }, + ], "redisConfigs": { # Optional. Key/Value pairs of customer overrides for mutable Redis Configs "a_key": "A String", }, @@ -306,6 +332,24 @@

Method Details

{ # A cluster instance. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. + "clusterEndpoints": [ # Optional. A list of cluster enpoints. + { # ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster. + "connections": [ # A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. + { # Detailed information of each PSC connection. + "pscConnection": { # Details of consumer resources in a PSC connection. # Detailed information of a PSC connection that is created by the customer who owns the cluster. + "address": "A String", # Required. The IP allocated on the consumer network for the PSC forwarding rule. + "connectionType": "A String", # Output only. Type of the PSC connection. + "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. + "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. + "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. + "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. + "serviceAttachment": "A String", # Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. + }, + }, + ], + }, + ], "createTime": "A String", # Output only. The timestamp associated with the cluster creation request. "crossClusterReplicationConfig": { # Cross cluster replication config. # Optional. Cross cluster replication config. "clusterRole": "A String", # The role of the cluster in cross cluster replication. @@ -375,7 +419,7 @@

Method Details

}, }, "preciseSizeGb": 3.14, # Output only. Precise value of redis memory size in GB for the entire cluster. - "pscConfigs": [ # Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported. + "pscConfigs": [ # Optional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported. { "network": "A String", # Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{network_project}/global/networks/{network_id}. }, @@ -383,13 +427,21 @@

Method Details

"pscConnections": [ # Output only. The list of PSC connections that are auto-created through service connectivity automation. { # Details of consumer resources in a PSC connection. "address": "A String", # Required. The IP allocated on the consumer network for the PSC forwarding rule. + "connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. + "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. "serviceAttachment": "A String", # Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. }, ], + "pscServiceAttachments": [ # Output only. Service attachment details to configure Psc connections + { # Configuration of a service attachment of the cluster, for creating PSC connections. + "connectionType": "A String", # Output only. Type of a PSC connection targeting this service attachment. + "serviceAttachment": "A String", # Output only. Service attachment URI which your self-created PscConnection should use as target + }, + ], "redisConfigs": { # Optional. Key/Value pairs of customer overrides for mutable Redis Configs "a_key": "A String", }, @@ -460,6 +512,24 @@

Method Details

"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. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. + "clusterEndpoints": [ # Optional. A list of cluster enpoints. + { # ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster. + "connections": [ # A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. + { # Detailed information of each PSC connection. + "pscConnection": { # Details of consumer resources in a PSC connection. # Detailed information of a PSC connection that is created by the customer who owns the cluster. + "address": "A String", # Required. The IP allocated on the consumer network for the PSC forwarding rule. + "connectionType": "A String", # Output only. Type of the PSC connection. + "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. + "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. + "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. + "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. + "serviceAttachment": "A String", # Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. + }, + }, + ], + }, + ], "createTime": "A String", # Output only. The timestamp associated with the cluster creation request. "crossClusterReplicationConfig": { # Cross cluster replication config. # Optional. Cross cluster replication config. "clusterRole": "A String", # The role of the cluster in cross cluster replication. @@ -529,7 +599,7 @@

Method Details

}, }, "preciseSizeGb": 3.14, # Output only. Precise value of redis memory size in GB for the entire cluster. - "pscConfigs": [ # Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported. + "pscConfigs": [ # Optional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported. { "network": "A String", # Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{network_project}/global/networks/{network_id}. }, @@ -537,13 +607,21 @@

Method Details

"pscConnections": [ # Output only. The list of PSC connections that are auto-created through service connectivity automation. { # Details of consumer resources in a PSC connection. "address": "A String", # Required. The IP allocated on the consumer network for the PSC forwarding rule. + "connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. + "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. "serviceAttachment": "A String", # Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. }, ], + "pscServiceAttachments": [ # Output only. Service attachment details to configure Psc connections + { # Configuration of a service attachment of the cluster, for creating PSC connections. + "connectionType": "A String", # Output only. Type of a PSC connection targeting this service attachment. + "serviceAttachment": "A String", # Output only. Service attachment URI which your self-created PscConnection should use as target + }, + ], "redisConfigs": { # Optional. Key/Value pairs of customer overrides for mutable Redis Configs "a_key": "A String", }, @@ -597,6 +675,24 @@

Method Details

{ # A cluster instance. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. + "clusterEndpoints": [ # Optional. A list of cluster enpoints. + { # ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster. + "connections": [ # A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. + { # Detailed information of each PSC connection. + "pscConnection": { # Details of consumer resources in a PSC connection. # Detailed information of a PSC connection that is created by the customer who owns the cluster. + "address": "A String", # Required. The IP allocated on the consumer network for the PSC forwarding rule. + "connectionType": "A String", # Output only. Type of the PSC connection. + "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. + "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. + "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. + "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. + "serviceAttachment": "A String", # Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. + }, + }, + ], + }, + ], "createTime": "A String", # Output only. The timestamp associated with the cluster creation request. "crossClusterReplicationConfig": { # Cross cluster replication config. # Optional. Cross cluster replication config. "clusterRole": "A String", # The role of the cluster in cross cluster replication. @@ -666,7 +762,7 @@

Method Details

}, }, "preciseSizeGb": 3.14, # Output only. Precise value of redis memory size in GB for the entire cluster. - "pscConfigs": [ # Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported. + "pscConfigs": [ # Optional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported. { "network": "A String", # Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{network_project}/global/networks/{network_id}. }, @@ -674,13 +770,21 @@

Method Details

"pscConnections": [ # Output only. The list of PSC connections that are auto-created through service connectivity automation. { # Details of consumer resources in a PSC connection. "address": "A String", # Required. The IP allocated on the consumer network for the PSC forwarding rule. + "connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. + "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. "serviceAttachment": "A String", # Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. }, ], + "pscServiceAttachments": [ # Output only. Service attachment details to configure Psc connections + { # Configuration of a service attachment of the cluster, for creating PSC connections. + "connectionType": "A String", # Output only. Type of a PSC connection targeting this service attachment. + "serviceAttachment": "A String", # Output only. Service attachment URI which your self-created PscConnection should use as target + }, + ], "redisConfigs": { # Optional. Key/Value pairs of customer overrides for mutable Redis Configs "a_key": "A String", }, diff --git a/docs/dyn/redis_v1beta1.projects.locations.clusters.html b/docs/dyn/redis_v1beta1.projects.locations.clusters.html index 53709f1800..684afdbbf2 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1beta1.projects.locations.clusters.html @@ -118,6 +118,24 @@

Method Details

{ # A cluster instance. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. + "clusterEndpoints": [ # Optional. A list of cluster enpoints. + { # ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster. + "connections": [ # A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. + { # Detailed information of each PSC connection. + "pscConnection": { # Details of consumer resources in a PSC connection. # Detailed information of a PSC connection that is created by the customer who owns the cluster. + "address": "A String", # Required. The IP allocated on the consumer network for the PSC forwarding rule. + "connectionType": "A String", # Output only. Type of the PSC connection. + "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. + "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. + "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. + "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. + "serviceAttachment": "A String", # Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. + }, + }, + ], + }, + ], "createTime": "A String", # Output only. The timestamp associated with the cluster creation request. "crossClusterReplicationConfig": { # Cross cluster replication config. # Optional. Cross cluster replication config. "clusterRole": "A String", # The role of the cluster in cross cluster replication. @@ -187,7 +205,7 @@

Method Details

}, }, "preciseSizeGb": 3.14, # Output only. Precise value of redis memory size in GB for the entire cluster. - "pscConfigs": [ # Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported. + "pscConfigs": [ # Optional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported. { "network": "A String", # Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{network_project}/global/networks/{network_id}. }, @@ -195,13 +213,21 @@

Method Details

"pscConnections": [ # Output only. The list of PSC connections that are auto-created through service connectivity automation. { # Details of consumer resources in a PSC connection. "address": "A String", # Required. The IP allocated on the consumer network for the PSC forwarding rule. + "connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. + "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. "serviceAttachment": "A String", # Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. }, ], + "pscServiceAttachments": [ # Output only. Service attachment details to configure Psc connections + { # Configuration of a service attachment of the cluster, for creating PSC connections. + "connectionType": "A String", # Output only. Type of a PSC connection targeting this service attachment. + "serviceAttachment": "A String", # Output only. Service attachment URI which your self-created PscConnection should use as target + }, + ], "redisConfigs": { # Optional. Key/Value pairs of customer overrides for mutable Redis Configs "a_key": "A String", }, @@ -306,6 +332,24 @@

Method Details

{ # A cluster instance. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. + "clusterEndpoints": [ # Optional. A list of cluster enpoints. + { # ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster. + "connections": [ # A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. + { # Detailed information of each PSC connection. + "pscConnection": { # Details of consumer resources in a PSC connection. # Detailed information of a PSC connection that is created by the customer who owns the cluster. + "address": "A String", # Required. The IP allocated on the consumer network for the PSC forwarding rule. + "connectionType": "A String", # Output only. Type of the PSC connection. + "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. + "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. + "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. + "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. + "serviceAttachment": "A String", # Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. + }, + }, + ], + }, + ], "createTime": "A String", # Output only. The timestamp associated with the cluster creation request. "crossClusterReplicationConfig": { # Cross cluster replication config. # Optional. Cross cluster replication config. "clusterRole": "A String", # The role of the cluster in cross cluster replication. @@ -375,7 +419,7 @@

Method Details

}, }, "preciseSizeGb": 3.14, # Output only. Precise value of redis memory size in GB for the entire cluster. - "pscConfigs": [ # Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported. + "pscConfigs": [ # Optional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported. { "network": "A String", # Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{network_project}/global/networks/{network_id}. }, @@ -383,13 +427,21 @@

Method Details

"pscConnections": [ # Output only. The list of PSC connections that are auto-created through service connectivity automation. { # Details of consumer resources in a PSC connection. "address": "A String", # Required. The IP allocated on the consumer network for the PSC forwarding rule. + "connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. + "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. "serviceAttachment": "A String", # Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. }, ], + "pscServiceAttachments": [ # Output only. Service attachment details to configure Psc connections + { # Configuration of a service attachment of the cluster, for creating PSC connections. + "connectionType": "A String", # Output only. Type of a PSC connection targeting this service attachment. + "serviceAttachment": "A String", # Output only. Service attachment URI which your self-created PscConnection should use as target + }, + ], "redisConfigs": { # Optional. Key/Value pairs of customer overrides for mutable Redis Configs "a_key": "A String", }, @@ -460,6 +512,24 @@

Method Details

"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. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. + "clusterEndpoints": [ # Optional. A list of cluster enpoints. + { # ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster. + "connections": [ # A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. + { # Detailed information of each PSC connection. + "pscConnection": { # Details of consumer resources in a PSC connection. # Detailed information of a PSC connection that is created by the customer who owns the cluster. + "address": "A String", # Required. The IP allocated on the consumer network for the PSC forwarding rule. + "connectionType": "A String", # Output only. Type of the PSC connection. + "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. + "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. + "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. + "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. + "serviceAttachment": "A String", # Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. + }, + }, + ], + }, + ], "createTime": "A String", # Output only. The timestamp associated with the cluster creation request. "crossClusterReplicationConfig": { # Cross cluster replication config. # Optional. Cross cluster replication config. "clusterRole": "A String", # The role of the cluster in cross cluster replication. @@ -529,7 +599,7 @@

Method Details

}, }, "preciseSizeGb": 3.14, # Output only. Precise value of redis memory size in GB for the entire cluster. - "pscConfigs": [ # Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported. + "pscConfigs": [ # Optional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported. { "network": "A String", # Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{network_project}/global/networks/{network_id}. }, @@ -537,13 +607,21 @@

Method Details

"pscConnections": [ # Output only. The list of PSC connections that are auto-created through service connectivity automation. { # Details of consumer resources in a PSC connection. "address": "A String", # Required. The IP allocated on the consumer network for the PSC forwarding rule. + "connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. + "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. "serviceAttachment": "A String", # Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. }, ], + "pscServiceAttachments": [ # Output only. Service attachment details to configure Psc connections + { # Configuration of a service attachment of the cluster, for creating PSC connections. + "connectionType": "A String", # Output only. Type of a PSC connection targeting this service attachment. + "serviceAttachment": "A String", # Output only. Service attachment URI which your self-created PscConnection should use as target + }, + ], "redisConfigs": { # Optional. Key/Value pairs of customer overrides for mutable Redis Configs "a_key": "A String", }, @@ -597,6 +675,24 @@

Method Details

{ # A cluster instance. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. + "clusterEndpoints": [ # Optional. A list of cluster enpoints. + { # ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster. + "connections": [ # A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. + { # Detailed information of each PSC connection. + "pscConnection": { # Details of consumer resources in a PSC connection. # Detailed information of a PSC connection that is created by the customer who owns the cluster. + "address": "A String", # Required. The IP allocated on the consumer network for the PSC forwarding rule. + "connectionType": "A String", # Output only. Type of the PSC connection. + "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. + "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. + "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. + "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. + "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. + "serviceAttachment": "A String", # Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. + }, + }, + ], + }, + ], "createTime": "A String", # Output only. The timestamp associated with the cluster creation request. "crossClusterReplicationConfig": { # Cross cluster replication config. # Optional. Cross cluster replication config. "clusterRole": "A String", # The role of the cluster in cross cluster replication. @@ -666,7 +762,7 @@

Method Details

}, }, "preciseSizeGb": 3.14, # Output only. Precise value of redis memory size in GB for the entire cluster. - "pscConfigs": [ # Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported. + "pscConfigs": [ # Optional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported. { "network": "A String", # Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{network_project}/global/networks/{network_id}. }, @@ -674,13 +770,21 @@

Method Details

"pscConnections": [ # Output only. The list of PSC connections that are auto-created through service connectivity automation. { # Details of consumer resources in a PSC connection. "address": "A String", # Required. The IP allocated on the consumer network for the PSC forwarding rule. + "connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. + "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. "serviceAttachment": "A String", # Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. }, ], + "pscServiceAttachments": [ # Output only. Service attachment details to configure Psc connections + { # Configuration of a service attachment of the cluster, for creating PSC connections. + "connectionType": "A String", # Output only. Type of a PSC connection targeting this service attachment. + "serviceAttachment": "A String", # Output only. Service attachment URI which your self-created PscConnection should use as target + }, + ], "redisConfigs": { # Optional. Key/Value pairs of customer overrides for mutable Redis Configs "a_key": "A String", }, diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.models.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.models.html index a1c006aaf7..3678d808e9 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.models.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.models.html @@ -129,9 +129,6 @@

Method Details

"frequentlyBoughtTogetherConfig": { # Additional configs for the frequently-bought-together model type. # Additional configs for frequently-bought-together models. "contextProductsType": "A String", # Optional. Specifies the context of the model when it is used in predict requests. Can only be set for the `frequently-bought-together` type. If it isn't specified, it defaults to MULTIPLE_CONTEXT_PRODUCTS. }, - "llmEmbeddingConfig": { # Config that turns on usage of llm embeddings as features to the model. Embeddings leverage unstructured text fields like description and title. # Optional. LLM embedding config to use for this model. - "llmEmbeddingVersion": "A String", # Optional. The LLM embedding version to use. Currently only `v0` is supported. If not specified, feature will not be turned on. - }, }, "name": "A String", # Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40. "optimizationObjective": "A String", # Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs. @@ -239,9 +236,6 @@

Method Details

"frequentlyBoughtTogetherConfig": { # Additional configs for the frequently-bought-together model type. # Additional configs for frequently-bought-together models. "contextProductsType": "A String", # Optional. Specifies the context of the model when it is used in predict requests. Can only be set for the `frequently-bought-together` type. If it isn't specified, it defaults to MULTIPLE_CONTEXT_PRODUCTS. }, - "llmEmbeddingConfig": { # Config that turns on usage of llm embeddings as features to the model. Embeddings leverage unstructured text fields like description and title. # Optional. LLM embedding config to use for this model. - "llmEmbeddingVersion": "A String", # Optional. The LLM embedding version to use. Currently only `v0` is supported. If not specified, feature will not be turned on. - }, }, "name": "A String", # Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40. "optimizationObjective": "A String", # Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs. @@ -306,9 +300,6 @@

Method Details

"frequentlyBoughtTogetherConfig": { # Additional configs for the frequently-bought-together model type. # Additional configs for frequently-bought-together models. "contextProductsType": "A String", # Optional. Specifies the context of the model when it is used in predict requests. Can only be set for the `frequently-bought-together` type. If it isn't specified, it defaults to MULTIPLE_CONTEXT_PRODUCTS. }, - "llmEmbeddingConfig": { # Config that turns on usage of llm embeddings as features to the model. Embeddings leverage unstructured text fields like description and title. # Optional. LLM embedding config to use for this model. - "llmEmbeddingVersion": "A String", # Optional. The LLM embedding version to use. Currently only `v0` is supported. If not specified, feature will not be turned on. - }, }, "name": "A String", # Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40. "optimizationObjective": "A String", # Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs. @@ -381,9 +372,6 @@

Method Details

"frequentlyBoughtTogetherConfig": { # Additional configs for the frequently-bought-together model type. # Additional configs for frequently-bought-together models. "contextProductsType": "A String", # Optional. Specifies the context of the model when it is used in predict requests. Can only be set for the `frequently-bought-together` type. If it isn't specified, it defaults to MULTIPLE_CONTEXT_PRODUCTS. }, - "llmEmbeddingConfig": { # Config that turns on usage of llm embeddings as features to the model. Embeddings leverage unstructured text fields like description and title. # Optional. LLM embedding config to use for this model. - "llmEmbeddingVersion": "A String", # Optional. The LLM embedding version to use. Currently only `v0` is supported. If not specified, feature will not be turned on. - }, }, "name": "A String", # Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40. "optimizationObjective": "A String", # Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs. @@ -438,9 +426,6 @@

Method Details

"frequentlyBoughtTogetherConfig": { # Additional configs for the frequently-bought-together model type. # Additional configs for frequently-bought-together models. "contextProductsType": "A String", # Optional. Specifies the context of the model when it is used in predict requests. Can only be set for the `frequently-bought-together` type. If it isn't specified, it defaults to MULTIPLE_CONTEXT_PRODUCTS. }, - "llmEmbeddingConfig": { # Config that turns on usage of llm embeddings as features to the model. Embeddings leverage unstructured text fields like description and title. # Optional. LLM embedding config to use for this model. - "llmEmbeddingVersion": "A String", # Optional. The LLM embedding version to use. Currently only `v0` is supported. If not specified, feature will not be turned on. - }, }, "name": "A String", # Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40. "optimizationObjective": "A String", # Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs. @@ -507,9 +492,6 @@

Method Details

"frequentlyBoughtTogetherConfig": { # Additional configs for the frequently-bought-together model type. # Additional configs for frequently-bought-together models. "contextProductsType": "A String", # Optional. Specifies the context of the model when it is used in predict requests. Can only be set for the `frequently-bought-together` type. If it isn't specified, it defaults to MULTIPLE_CONTEXT_PRODUCTS. }, - "llmEmbeddingConfig": { # Config that turns on usage of llm embeddings as features to the model. Embeddings leverage unstructured text fields like description and title. # Optional. LLM embedding config to use for this model. - "llmEmbeddingVersion": "A String", # Optional. The LLM embedding version to use. Currently only `v0` is supported. If not specified, feature will not be turned on. - }, }, "name": "A String", # Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40. "optimizationObjective": "A String", # Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs. @@ -576,9 +558,6 @@

Method Details

"frequentlyBoughtTogetherConfig": { # Additional configs for the frequently-bought-together model type. # Additional configs for frequently-bought-together models. "contextProductsType": "A String", # Optional. Specifies the context of the model when it is used in predict requests. Can only be set for the `frequently-bought-together` type. If it isn't specified, it defaults to MULTIPLE_CONTEXT_PRODUCTS. }, - "llmEmbeddingConfig": { # Config that turns on usage of llm embeddings as features to the model. Embeddings leverage unstructured text fields like description and title. # Optional. LLM embedding config to use for this model. - "llmEmbeddingVersion": "A String", # Optional. The LLM embedding version to use. Currently only `v0` is supported. If not specified, feature will not be turned on. - }, }, "name": "A String", # Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40. "optimizationObjective": "A String", # Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs. diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html index ad6f79f0cb..f09e10b0cc 100644 --- a/docs/dyn/run_v2.projects.locations.services.html +++ b/docs/dyn/run_v2.projects.locations.services.html @@ -159,7 +159,7 @@

Method Details

"expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted. "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. "ingress": "A String", # Optional. Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. - "invokerIamDisabled": True or False, # Optional. Disables IAM permission check for run.routes.invoke for callers of this service. This setting should not be used with external ingress. + "invokerIamDisabled": True or False, # Optional. Disables IAM permission check for run.routes.invoke for callers of this service. This feature is available by invitation only. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check. "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Service. "a_key": "A String", }, @@ -493,7 +493,7 @@

Method Details

"expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted. "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. "ingress": "A String", # Optional. Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. - "invokerIamDisabled": True or False, # Optional. Disables IAM permission check for run.routes.invoke for callers of this service. This setting should not be used with external ingress. + "invokerIamDisabled": True or False, # Optional. Disables IAM permission check for run.routes.invoke for callers of this service. This feature is available by invitation only. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check. "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Service. "a_key": "A String", }, @@ -814,7 +814,7 @@

Method Details

"expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted. "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. "ingress": "A String", # Optional. Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. - "invokerIamDisabled": True or False, # Optional. Disables IAM permission check for run.routes.invoke for callers of this service. This setting should not be used with external ingress. + "invokerIamDisabled": True or False, # Optional. Disables IAM permission check for run.routes.invoke for callers of this service. This feature is available by invitation only. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check. "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Service. "a_key": "A String", }, @@ -1092,7 +1092,7 @@

Method Details

"expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted. "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. "ingress": "A String", # Optional. Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. - "invokerIamDisabled": True or False, # Optional. Disables IAM permission check for run.routes.invoke for callers of this service. This setting should not be used with external ingress. + "invokerIamDisabled": True or False, # Optional. Disables IAM permission check for run.routes.invoke for callers of this service. This feature is available by invitation only. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check. "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Service. "a_key": "A String", }, diff --git a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html index 16639b95a7..3dbd910c5f 100644 --- a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html @@ -122,9 +122,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -171,9 +168,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -245,9 +239,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -306,9 +297,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -369,9 +357,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -450,9 +435,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -500,9 +482,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -550,9 +529,6 @@

Method Details

{ # Request message to simulate a CustomConfig against a given test resource. Maximum size of the request is 4 MB by default. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # Required. The custom configuration that you need to test. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. diff --git a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.effectiveCustomModules.html b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.effectiveCustomModules.html index 2848889505..927f071ff6 100644 --- a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.effectiveCustomModules.html +++ b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.effectiveCustomModules.html @@ -108,9 +108,6 @@

Method Details

{ # An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # Output only. The user-specified configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -165,9 +162,6 @@

Method Details

"effectiveSecurityHealthAnalyticsCustomModules": [ # Effective custom modules belonging to the requested parent. { # An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # Output only. The user-specified configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. diff --git a/docs/dyn/securitycenter_v1.folders.sources.findings.html b/docs/dyn/securitycenter_v1.folders.sources.findings.html index ebc5544a29..b6e2dc032e 100644 --- a/docs/dyn/securitycenter_v1.folders.sources.findings.html +++ b/docs/dyn/securitycenter_v1.folders.sources.findings.html @@ -2600,7 +2600,7 @@

Method Details

The object takes the form of: { # Request message for updating a finding's state. - "startTime": "A String", # Required. The time at which the updated state takes effect. + "startTime": "A String", # Optional. The time at which the updated state takes effect. If unset, defaults to the request time. "state": "A String", # Required. The desired State of the finding. } diff --git a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html index 7e30880e22..ac3419c5de 100644 --- a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html @@ -122,9 +122,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -171,9 +168,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -245,9 +239,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -306,9 +297,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -369,9 +357,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -450,9 +435,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -500,9 +482,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -550,9 +529,6 @@

Method Details

{ # Request message to simulate a CustomConfig against a given test resource. Maximum size of the request is 4 MB by default. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # Required. The custom configuration that you need to test. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. diff --git a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.effectiveCustomModules.html b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.effectiveCustomModules.html index 479ddba7fa..a94a6503ec 100644 --- a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.effectiveCustomModules.html +++ b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.effectiveCustomModules.html @@ -108,9 +108,6 @@

Method Details

{ # An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # Output only. The user-specified configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -165,9 +162,6 @@

Method Details

"effectiveSecurityHealthAnalyticsCustomModules": [ # Effective custom modules belonging to the requested parent. { # An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # Output only. The user-specified configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. diff --git a/docs/dyn/securitycenter_v1.organizations.sources.findings.html b/docs/dyn/securitycenter_v1.organizations.sources.findings.html index 96267d6da7..c502116d81 100644 --- a/docs/dyn/securitycenter_v1.organizations.sources.findings.html +++ b/docs/dyn/securitycenter_v1.organizations.sources.findings.html @@ -3758,7 +3758,7 @@

Method Details

The object takes the form of: { # Request message for updating a finding's state. - "startTime": "A String", # Required. The time at which the updated state takes effect. + "startTime": "A String", # Optional. The time at which the updated state takes effect. If unset, defaults to the request time. "state": "A String", # Required. The desired State of the finding. } diff --git a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html index 8868070d89..46e13e5007 100644 --- a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html @@ -122,9 +122,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -171,9 +168,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -245,9 +239,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -306,9 +297,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -369,9 +357,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -450,9 +435,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -500,9 +482,6 @@

Method Details

{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -550,9 +529,6 @@

Method Details

{ # Request message to simulate a CustomConfig against a given test resource. Maximum size of the request is 4 MB by default. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # Required. The custom configuration that you need to test. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. diff --git a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.effectiveCustomModules.html b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.effectiveCustomModules.html index 1431ca6172..16661fed85 100644 --- a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.effectiveCustomModules.html +++ b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.effectiveCustomModules.html @@ -108,9 +108,6 @@

Method Details

{ # An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # Output only. The user-specified configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. @@ -165,9 +162,6 @@

Method Details

"effectiveSecurityHealthAnalyticsCustomModules": [ # Effective custom modules belonging to the requested parent. { # An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only. "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # Output only. The user-specified configuration for the module. - "celPolicy": { # YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. # The CEL policy spec attached to the custom module. - "spec": "A String", # The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. - }, "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. "properties": [ # A list of custom output properties to add to the finding. { # An individual name-value pair that defines a custom source property. diff --git a/docs/dyn/securitycenter_v1.projects.sources.findings.html b/docs/dyn/securitycenter_v1.projects.sources.findings.html index 99902ea644..326e1645fe 100644 --- a/docs/dyn/securitycenter_v1.projects.sources.findings.html +++ b/docs/dyn/securitycenter_v1.projects.sources.findings.html @@ -2600,7 +2600,7 @@

Method Details

The object takes the form of: { # Request message for updating a finding's state. - "startTime": "A String", # Required. The time at which the updated state takes effect. + "startTime": "A String", # Optional. The time at which the updated state takes effect. If unset, defaults to the request time. "state": "A String", # Required. The desired State of the finding. } diff --git a/docs/dyn/sheets_v4.spreadsheets.html b/docs/dyn/sheets_v4.spreadsheets.html index c195d9648b..09d0be9ff6 100644 --- a/docs/dyn/sheets_v4.spreadsheets.html +++ b/docs/dyn/sheets_v4.spreadsheets.html @@ -11507,10 +11507,10 @@

Method Details

{ # Schedule for refreshing the data source. Data sources in the spreadsheet are refreshed within a time interval. You can specify the start time by clicking the Scheduled Refresh button in the Sheets editor, but the interval is fixed at 4 hours. For example, if you specify a start time of 8 AM , the refresh will take place between 8 AM and 12 PM every day. "dailySchedule": { # A schedule for data to refresh every day in a given time interval. # Daily refresh schedule. "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "enabled": True or False, # True if the refresh schedule is enabled, or false otherwise. @@ -11519,10 +11519,10 @@

Method Details

42, ], "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "nextRun": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. The time interval of the next run. @@ -11535,10 +11535,10 @@

Method Details

"A String", ], "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, }, @@ -15172,10 +15172,10 @@

Method Details

{ # Schedule for refreshing the data source. Data sources in the spreadsheet are refreshed within a time interval. You can specify the start time by clicking the Scheduled Refresh button in the Sheets editor, but the interval is fixed at 4 hours. For example, if you specify a start time of 8 AM , the refresh will take place between 8 AM and 12 PM every day. "dailySchedule": { # A schedule for data to refresh every day in a given time interval. # Daily refresh schedule. "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "enabled": True or False, # True if the refresh schedule is enabled, or false otherwise. @@ -15184,10 +15184,10 @@

Method Details

42, ], "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "nextRun": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. The time interval of the next run. @@ -15200,10 +15200,10 @@

Method Details

"A String", ], "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, }, @@ -18830,10 +18830,10 @@

Method Details

{ # Schedule for refreshing the data source. Data sources in the spreadsheet are refreshed within a time interval. You can specify the start time by clicking the Scheduled Refresh button in the Sheets editor, but the interval is fixed at 4 hours. For example, if you specify a start time of 8 AM , the refresh will take place between 8 AM and 12 PM every day. "dailySchedule": { # A schedule for data to refresh every day in a given time interval. # Daily refresh schedule. "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "enabled": True or False, # True if the refresh schedule is enabled, or false otherwise. @@ -18842,10 +18842,10 @@

Method Details

42, ], "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "nextRun": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. The time interval of the next run. @@ -18858,10 +18858,10 @@

Method Details

"A String", ], "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, }, @@ -22497,10 +22497,10 @@

Method Details

{ # Schedule for refreshing the data source. Data sources in the spreadsheet are refreshed within a time interval. You can specify the start time by clicking the Scheduled Refresh button in the Sheets editor, but the interval is fixed at 4 hours. For example, if you specify a start time of 8 AM , the refresh will take place between 8 AM and 12 PM every day. "dailySchedule": { # A schedule for data to refresh every day in a given time interval. # Daily refresh schedule. "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "enabled": True or False, # True if the refresh schedule is enabled, or false otherwise. @@ -22509,10 +22509,10 @@

Method Details

42, ], "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "nextRun": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. The time interval of the next run. @@ -22525,10 +22525,10 @@

Method Details

"A String", ], "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, }, @@ -26200,10 +26200,10 @@

Method Details

{ # Schedule for refreshing the data source. Data sources in the spreadsheet are refreshed within a time interval. You can specify the start time by clicking the Scheduled Refresh button in the Sheets editor, but the interval is fixed at 4 hours. For example, if you specify a start time of 8 AM , the refresh will take place between 8 AM and 12 PM every day. "dailySchedule": { # A schedule for data to refresh every day in a given time interval. # Daily refresh schedule. "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "enabled": True or False, # True if the refresh schedule is enabled, or false otherwise. @@ -26212,10 +26212,10 @@

Method Details

42, ], "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, "nextRun": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. The time interval of the next run. @@ -26228,10 +26228,10 @@

Method Details

"A String", ], "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, }, diff --git a/docs/dyn/spanner_v1.projects.instances.html b/docs/dyn/spanner_v1.projects.instances.html index 988253613b..40484b2600 100644 --- a/docs/dyn/spanner_v1.projects.instances.html +++ b/docs/dyn/spanner_v1.projects.instances.html @@ -160,6 +160,22 @@

Method Details

{ # The request for CreateInstance. "instance": { # An isolated set of Cloud Spanner resources on which databases can be hosted. # Required. The instance to create. The name may be omitted, but if specified must be `/instances/`. "autoscalingConfig": { # Autoscaling configuration for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. + "asymmetricAutoscalingOptions": [ # Optional. Optional asymmetric autoscaling options. Replicas matching the replica selection criteria will be autoscaled independently from other replicas. The autoscaler will scale the replicas based on the utilization of replicas identified by the replica selection. Replica selections should not overlap with each other. Other replicas (those do not match any replica selection) will be autoscaled together and will have the same compute capacity allocated to them. + { # AsymmetricAutoscalingOption specifies the scaling of replicas identified by the given selection. + "overrides": { # Overrides the top-level autoscaling configuration for the replicas identified by `replica_selection`. All fields in this message are optional. Any unspecified fields will use the corresponding values from the top-level autoscaling configuration. # Optional. Overrides applied to the top-level autoscaling configuration for the selected replicas. + "autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Optional. If specified, overrides the min/max limit in the top-level autoscaling configuration for the selected replicas. + "maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes. + "maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units. + "minNodes": 42, # Minimum number of nodes allocated to the instance. If set, this number should be greater than or equal to 1. + "minProcessingUnits": 42, # Minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000. + }, + "autoscalingTargetHighPriorityCpuUtilizationPercent": 42, # Optional. If specified, overrides the autoscaling target high_priority_cpu_utilization_percent in the top-level autoscaling configuration for the selected replicas. + }, + "replicaSelection": { # ReplicaSelection identifies replicas with common properties. # Required. Selects the replicas to which this AsymmetricAutoscalingOption applies. Only read-only replicas are supported. + "location": "A String", # Required. Name of the location of the replicas (e.g., "us-central1"). + }, + }, + ], "autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Required. Autoscaling limits for an instance. "maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes. "maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units. @@ -188,8 +204,17 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. - "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). - "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying node count across replicas (achieved by setting asymmetric_autoscaling_options in autoscaling config), the node_count here is the maximum node count across all replicas. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying processing units per replica (achieved by setting asymmetric_autoscaling_options in autoscaling config), the processing_units here is the maximum processing units across all replicas. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "replicaComputeCapacity": [ # Output only. Lists the compute capacity per ReplicaSelection. A replica selection identifies a set of replicas with common properties. Replicas identified by a ReplicaSelection are scaled with the same compute capacity. + { # ReplicaComputeCapacity describes the amount of server resources that are allocated to each replica identified by the replica selection. + "nodeCount": 42, # The number of nodes allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. + "processingUnits": 42, # The number of processing units allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. + "replicaSelection": { # ReplicaSelection identifies replicas with common properties. # Required. Identifies replicas by specified properties. All replicas in the selection have the same amount of compute capacity. + "location": "A String", # Required. Name of the location of the replicas (e.g., "us-central1"). + }, + }, + ], "state": "A String", # Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`. "updateTime": "A String", # Output only. The time at which the instance was most recently updated. }, @@ -260,6 +285,22 @@

Method Details

{ # An isolated set of Cloud Spanner resources on which databases can be hosted. "autoscalingConfig": { # Autoscaling configuration for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. + "asymmetricAutoscalingOptions": [ # Optional. Optional asymmetric autoscaling options. Replicas matching the replica selection criteria will be autoscaled independently from other replicas. The autoscaler will scale the replicas based on the utilization of replicas identified by the replica selection. Replica selections should not overlap with each other. Other replicas (those do not match any replica selection) will be autoscaled together and will have the same compute capacity allocated to them. + { # AsymmetricAutoscalingOption specifies the scaling of replicas identified by the given selection. + "overrides": { # Overrides the top-level autoscaling configuration for the replicas identified by `replica_selection`. All fields in this message are optional. Any unspecified fields will use the corresponding values from the top-level autoscaling configuration. # Optional. Overrides applied to the top-level autoscaling configuration for the selected replicas. + "autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Optional. If specified, overrides the min/max limit in the top-level autoscaling configuration for the selected replicas. + "maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes. + "maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units. + "minNodes": 42, # Minimum number of nodes allocated to the instance. If set, this number should be greater than or equal to 1. + "minProcessingUnits": 42, # Minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000. + }, + "autoscalingTargetHighPriorityCpuUtilizationPercent": 42, # Optional. If specified, overrides the autoscaling target high_priority_cpu_utilization_percent in the top-level autoscaling configuration for the selected replicas. + }, + "replicaSelection": { # ReplicaSelection identifies replicas with common properties. # Required. Selects the replicas to which this AsymmetricAutoscalingOption applies. Only read-only replicas are supported. + "location": "A String", # Required. Name of the location of the replicas (e.g., "us-central1"). + }, + }, + ], "autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Required. Autoscaling limits for an instance. "maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes. "maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units. @@ -288,8 +329,17 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. - "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). - "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying node count across replicas (achieved by setting asymmetric_autoscaling_options in autoscaling config), the node_count here is the maximum node count across all replicas. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying processing units per replica (achieved by setting asymmetric_autoscaling_options in autoscaling config), the processing_units here is the maximum processing units across all replicas. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "replicaComputeCapacity": [ # Output only. Lists the compute capacity per ReplicaSelection. A replica selection identifies a set of replicas with common properties. Replicas identified by a ReplicaSelection are scaled with the same compute capacity. + { # ReplicaComputeCapacity describes the amount of server resources that are allocated to each replica identified by the replica selection. + "nodeCount": 42, # The number of nodes allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. + "processingUnits": 42, # The number of processing units allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. + "replicaSelection": { # ReplicaSelection identifies replicas with common properties. # Required. Identifies replicas by specified properties. All replicas in the selection have the same amount of compute capacity. + "location": "A String", # Required. Name of the location of the replicas (e.g., "us-central1"). + }, + }, + ], "state": "A String", # Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`. "updateTime": "A String", # Output only. The time at which the instance was most recently updated. }
@@ -360,6 +410,22 @@

Method Details

"instances": [ # The list of requested instances. { # An isolated set of Cloud Spanner resources on which databases can be hosted. "autoscalingConfig": { # Autoscaling configuration for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. + "asymmetricAutoscalingOptions": [ # Optional. Optional asymmetric autoscaling options. Replicas matching the replica selection criteria will be autoscaled independently from other replicas. The autoscaler will scale the replicas based on the utilization of replicas identified by the replica selection. Replica selections should not overlap with each other. Other replicas (those do not match any replica selection) will be autoscaled together and will have the same compute capacity allocated to them. + { # AsymmetricAutoscalingOption specifies the scaling of replicas identified by the given selection. + "overrides": { # Overrides the top-level autoscaling configuration for the replicas identified by `replica_selection`. All fields in this message are optional. Any unspecified fields will use the corresponding values from the top-level autoscaling configuration. # Optional. Overrides applied to the top-level autoscaling configuration for the selected replicas. + "autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Optional. If specified, overrides the min/max limit in the top-level autoscaling configuration for the selected replicas. + "maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes. + "maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units. + "minNodes": 42, # Minimum number of nodes allocated to the instance. If set, this number should be greater than or equal to 1. + "minProcessingUnits": 42, # Minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000. + }, + "autoscalingTargetHighPriorityCpuUtilizationPercent": 42, # Optional. If specified, overrides the autoscaling target high_priority_cpu_utilization_percent in the top-level autoscaling configuration for the selected replicas. + }, + "replicaSelection": { # ReplicaSelection identifies replicas with common properties. # Required. Selects the replicas to which this AsymmetricAutoscalingOption applies. Only read-only replicas are supported. + "location": "A String", # Required. Name of the location of the replicas (e.g., "us-central1"). + }, + }, + ], "autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Required. Autoscaling limits for an instance. "maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes. "maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units. @@ -388,8 +454,17 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. - "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). - "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying node count across replicas (achieved by setting asymmetric_autoscaling_options in autoscaling config), the node_count here is the maximum node count across all replicas. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying processing units per replica (achieved by setting asymmetric_autoscaling_options in autoscaling config), the processing_units here is the maximum processing units across all replicas. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "replicaComputeCapacity": [ # Output only. Lists the compute capacity per ReplicaSelection. A replica selection identifies a set of replicas with common properties. Replicas identified by a ReplicaSelection are scaled with the same compute capacity. + { # ReplicaComputeCapacity describes the amount of server resources that are allocated to each replica identified by the replica selection. + "nodeCount": 42, # The number of nodes allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. + "processingUnits": 42, # The number of processing units allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. + "replicaSelection": { # ReplicaSelection identifies replicas with common properties. # Required. Identifies replicas by specified properties. All replicas in the selection have the same amount of compute capacity. + "location": "A String", # Required. Name of the location of the replicas (e.g., "us-central1"). + }, + }, + ], "state": "A String", # Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`. "updateTime": "A String", # Output only. The time at which the instance was most recently updated. }, @@ -470,6 +545,22 @@

Method Details

"fieldMask": "A String", # Required. A mask specifying which fields in Instance should be updated. The field mask must always be specified; this prevents any future fields in Instance from being erased accidentally by clients that do not know about them. "instance": { # An isolated set of Cloud Spanner resources on which databases can be hosted. # Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in field_mask need be included. "autoscalingConfig": { # Autoscaling configuration for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. + "asymmetricAutoscalingOptions": [ # Optional. Optional asymmetric autoscaling options. Replicas matching the replica selection criteria will be autoscaled independently from other replicas. The autoscaler will scale the replicas based on the utilization of replicas identified by the replica selection. Replica selections should not overlap with each other. Other replicas (those do not match any replica selection) will be autoscaled together and will have the same compute capacity allocated to them. + { # AsymmetricAutoscalingOption specifies the scaling of replicas identified by the given selection. + "overrides": { # Overrides the top-level autoscaling configuration for the replicas identified by `replica_selection`. All fields in this message are optional. Any unspecified fields will use the corresponding values from the top-level autoscaling configuration. # Optional. Overrides applied to the top-level autoscaling configuration for the selected replicas. + "autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Optional. If specified, overrides the min/max limit in the top-level autoscaling configuration for the selected replicas. + "maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes. + "maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units. + "minNodes": 42, # Minimum number of nodes allocated to the instance. If set, this number should be greater than or equal to 1. + "minProcessingUnits": 42, # Minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000. + }, + "autoscalingTargetHighPriorityCpuUtilizationPercent": 42, # Optional. If specified, overrides the autoscaling target high_priority_cpu_utilization_percent in the top-level autoscaling configuration for the selected replicas. + }, + "replicaSelection": { # ReplicaSelection identifies replicas with common properties. # Required. Selects the replicas to which this AsymmetricAutoscalingOption applies. Only read-only replicas are supported. + "location": "A String", # Required. Name of the location of the replicas (e.g., "us-central1"). + }, + }, + ], "autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Required. Autoscaling limits for an instance. "maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes. "maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units. @@ -498,8 +589,17 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. - "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). - "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying node count across replicas (achieved by setting asymmetric_autoscaling_options in autoscaling config), the node_count here is the maximum node count across all replicas. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying processing units per replica (achieved by setting asymmetric_autoscaling_options in autoscaling config), the processing_units here is the maximum processing units across all replicas. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "replicaComputeCapacity": [ # Output only. Lists the compute capacity per ReplicaSelection. A replica selection identifies a set of replicas with common properties. Replicas identified by a ReplicaSelection are scaled with the same compute capacity. + { # ReplicaComputeCapacity describes the amount of server resources that are allocated to each replica identified by the replica selection. + "nodeCount": 42, # The number of nodes allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. + "processingUnits": 42, # The number of processing units allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`. + "replicaSelection": { # ReplicaSelection identifies replicas with common properties. # Required. Identifies replicas by specified properties. All replicas in the selection have the same amount of compute capacity. + "location": "A String", # Required. Name of the location of the replicas (e.g., "us-central1"). + }, + }, + ], "state": "A String", # Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`. "updateTime": "A String", # Output only. The time at which the instance was most recently updated. }, diff --git a/docs/dyn/sqladmin_v1.instances.html b/docs/dyn/sqladmin_v1.instances.html index c5b60abb84..00b90556eb 100644 --- a/docs/dyn/sqladmin_v1.instances.html +++ b/docs/dyn/sqladmin_v1.instances.html @@ -76,7 +76,7 @@

Cloud SQL Admin API . ListServerCertificates(project, instance, x__xgafv=None)

-

Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.

+

Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out. For instances not using Certificate Authority Service (CAS) server CA, use ListServerCas instead.

RotateServerCertificate(project, instance, body=None, x__xgafv=None)

Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, use RotateServerCa instead.

@@ -170,7 +170,7 @@

Instance Methods

Method Details

ListServerCertificates(project, instance, x__xgafv=None) -
Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.
+  
Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out. For instances not using Certificate Authority Service (CAS) server CA, use ListServerCas instead.
 
 Args:
   project: string, Required. Project ID of the project that contains the instance. (required)
diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html
index db8deec1ce..2e9f5af72f 100644
--- a/docs/dyn/sqladmin_v1beta4.instances.html
+++ b/docs/dyn/sqladmin_v1beta4.instances.html
@@ -76,7 +76,7 @@ 

Cloud SQL Admin API . ListServerCertificates(project, instance, x__xgafv=None)

-

Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.

+

Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out. For instances not using Certificate Authority Service (CAS) server CA, use ListServerCas instead.

RotateServerCertificate(project, instance, body=None, x__xgafv=None)

Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, use RotateServerCa instead.

@@ -170,7 +170,7 @@

Instance Methods

Method Details

ListServerCertificates(project, instance, x__xgafv=None) -
Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.
+  
Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out. For instances not using Certificate Authority Service (CAS) server CA, use ListServerCas instead.
 
 Args:
   project: string, Required. Project ID of the project that contains the instance. (required)
diff --git a/docs/dyn/texttospeech_v1.projects.locations.html b/docs/dyn/texttospeech_v1.projects.locations.html
index 9273db9be7..b2f22cdbfa 100644
--- a/docs/dyn/texttospeech_v1.projects.locations.html
+++ b/docs/dyn/texttospeech_v1.projects.locations.html
@@ -121,6 +121,14 @@ 

Method Details

}, ], }, + "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. + "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. + }, + ], + }, "ssml": "A String", # The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml). "text": "A String", # The raw text to be synthesized. }, diff --git a/docs/dyn/texttospeech_v1.text.html b/docs/dyn/texttospeech_v1.text.html index 5aaf33d9e1..67533382f9 100644 --- a/docs/dyn/texttospeech_v1.text.html +++ b/docs/dyn/texttospeech_v1.text.html @@ -95,8 +95,8 @@

Method Details

The object takes the form of: { # The top-level message sent by the client for the `SynthesizeSpeech` method. - "advancedVoiceOptions": { # Used for advanced voice options. # Adnanced voice options. - "lowLatencyJourneySynthesis": True or False, # Only for Jounrney voices. If false, the synthesis will be context aware and have higher latency. + "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. }, "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. @@ -118,6 +118,14 @@

Method Details

}, ], }, + "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. + "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. + }, + ], + }, "ssml": "A String", # The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml). "text": "A String", # The raw text to be synthesized. }, diff --git a/docs/dyn/texttospeech_v1.voices.html b/docs/dyn/texttospeech_v1.voices.html index 3404291608..be8c030ae2 100644 --- a/docs/dyn/texttospeech_v1.voices.html +++ b/docs/dyn/texttospeech_v1.voices.html @@ -77,9 +77,6 @@

Instance Methods

close()

Close httplib2 connections.

-

- generateVoiceCloningKey(body=None, x__xgafv=None)

-

Generates voice clone key given a short voice prompt. This method validates the voice prompts with a series of checks against the voice talent statement to verify the voice clone is safe to generate.

list(languageCode=None, x__xgafv=None)

Returns a list of Voice supported for synthesis.

@@ -89,46 +86,6 @@

Method Details

Close httplib2 connections.
-
- generateVoiceCloningKey(body=None, x__xgafv=None) -
Generates voice clone key given a short voice prompt. This method validates the voice prompts with a series of checks against the voice talent statement to verify the voice clone is safe to generate.
-
-Args:
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request message for the `GenerateVoiceCloningKey` method.
-  "consentScript": "A String", # Required. The script used for the voice talent statement. The script will be provided to the caller through other channels. It must be returned unchanged in this field.
-  "languageCode": "A String", # Required. The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes.
-  "referenceAudio": { # Holds audio content and config. # Required. The training audio used to create voice clone. This is currently limited to LINEAR16 PCM WAV files mono audio with 24khz sample rate. This needs to be specified in [InputAudio.audio_config], other values will be explicitly rejected.
-    "audioConfig": { # Description of inputted audio data. # Required. Provides information that specifies how to process content.
-      "audioEncoding": "A String", # Required. The format of the audio byte stream.
-      "sampleRateHertz": 42, # Required. The sample rate (in hertz) for this audio.
-    },
-    "content": "A String", # Required. The audio data bytes encoded as specified in `InputAudioConfig`. Note: as with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64. Audio samples should be between 5-25 seconds in length.
-  },
-  "voiceTalentConsent": { # Holds audio content and config. # Required. The voice talent audio used to verify consent to voice clone.
-    "audioConfig": { # Description of inputted audio data. # Required. Provides information that specifies how to process content.
-      "audioEncoding": "A String", # Required. The format of the audio byte stream.
-      "sampleRateHertz": 42, # Required. The sample rate (in hertz) for this audio.
-    },
-    "content": "A String", # Required. The audio data bytes encoded as specified in `InputAudioConfig`. Note: as with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64. Audio samples should be between 5-25 seconds in length.
-  },
-}
-
-  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 the `GenerateVoiceCloningKey` method.
-  "voiceCloningKey": "A String", # The voice clone key. Use it in the SynthesizeSpeechRequest by setting [voice.voice_clone.voice_cloning_key].
-}
-
-
list(languageCode=None, x__xgafv=None)
Returns a list of Voice supported for synthesis.
diff --git a/docs/dyn/texttospeech_v1beta1.projects.locations.html b/docs/dyn/texttospeech_v1beta1.projects.locations.html
index 995f17cb7f..95075eedd3 100644
--- a/docs/dyn/texttospeech_v1beta1.projects.locations.html
+++ b/docs/dyn/texttospeech_v1beta1.projects.locations.html
@@ -121,6 +121,14 @@ 

Method Details

}, ], }, + "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. + "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. + }, + ], + }, "ssml": "A String", # The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml). "text": "A String", # The raw text to be synthesized. }, diff --git a/docs/dyn/texttospeech_v1beta1.text.html b/docs/dyn/texttospeech_v1beta1.text.html index 6dbab38493..22b5bc9a7e 100644 --- a/docs/dyn/texttospeech_v1beta1.text.html +++ b/docs/dyn/texttospeech_v1beta1.text.html @@ -95,8 +95,8 @@

Method Details

The object takes the form of: { # The top-level message sent by the client for the `SynthesizeSpeech` method. - "advancedVoiceOptions": { # Used for advanced voice options. # Adnanced voice options. - "lowLatencyJourneySynthesis": True or False, # Only for Jounrney voices. If false, the synthesis will be context aware and have higher latency. + "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. }, "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. @@ -121,6 +121,14 @@

Method Details

}, ], }, + "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. + "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. + }, + ], + }, "ssml": "A String", # The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml). "text": "A String", # The raw text to be synthesized. }, diff --git a/docs/dyn/texttospeech_v1beta1.voices.html b/docs/dyn/texttospeech_v1beta1.voices.html index 08d0b29d96..709d6ed2f1 100644 --- a/docs/dyn/texttospeech_v1beta1.voices.html +++ b/docs/dyn/texttospeech_v1beta1.voices.html @@ -77,9 +77,6 @@

Instance Methods

close()

Close httplib2 connections.

-

- generateVoiceCloningKey(body=None, x__xgafv=None)

-

Generates voice clone key given a short voice prompt. This method validates the voice prompts with a series of checks against the voice talent statement to verify the voice clone is safe to generate.

list(languageCode=None, x__xgafv=None)

Returns a list of Voice supported for synthesis.

@@ -89,46 +86,6 @@

Method Details

Close httplib2 connections.
-
- generateVoiceCloningKey(body=None, x__xgafv=None) -
Generates voice clone key given a short voice prompt. This method validates the voice prompts with a series of checks against the voice talent statement to verify the voice clone is safe to generate.
-
-Args:
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request message for the `GenerateVoiceCloningKey` method.
-  "consentScript": "A String", # Required. The script used for the voice talent statement. The script will be provided to the caller through other channels. It must be returned unchanged in this field.
-  "languageCode": "A String", # Required. The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes.
-  "referenceAudio": { # Holds audio content and config. # Required. The training audio used to create voice clone. This is currently limited to LINEAR16 PCM WAV files mono audio with 24khz sample rate. This needs to be specified in [InputAudio.audio_config], other values will be explicitly rejected.
-    "audioConfig": { # Description of inputted audio data. # Required. Provides information that specifies how to process content.
-      "audioEncoding": "A String", # Required. The format of the audio byte stream.
-      "sampleRateHertz": 42, # Required. The sample rate (in hertz) for this audio.
-    },
-    "content": "A String", # Required. The audio data bytes encoded as specified in `InputAudioConfig`. Note: as with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64. Audio samples should be between 5-25 seconds in length.
-  },
-  "voiceTalentConsent": { # Holds audio content and config. # Required. The voice talent audio used to verify consent to voice clone.
-    "audioConfig": { # Description of inputted audio data. # Required. Provides information that specifies how to process content.
-      "audioEncoding": "A String", # Required. The format of the audio byte stream.
-      "sampleRateHertz": 42, # Required. The sample rate (in hertz) for this audio.
-    },
-    "content": "A String", # Required. The audio data bytes encoded as specified in `InputAudioConfig`. Note: as with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64. Audio samples should be between 5-25 seconds in length.
-  },
-}
-
-  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 the `GenerateVoiceCloningKey` method.
-  "voiceCloningKey": "A String", # The voice clone key. Use it in the SynthesizeSpeechRequest by setting [voice.voice_clone.voice_cloning_key].
-}
-
-
list(languageCode=None, x__xgafv=None)
Returns a list of Voice supported for synthesis.
diff --git a/docs/dyn/tpu_v2alpha1.projects.locations.queuedResources.html b/docs/dyn/tpu_v2alpha1.projects.locations.queuedResources.html
index d0ada3f015..d21ff4b80d 100644
--- a/docs/dyn/tpu_v2alpha1.projects.locations.queuedResources.html
+++ b/docs/dyn/tpu_v2alpha1.projects.locations.queuedResources.html
@@ -167,6 +167,7 @@ 

Method Details

"multiNodeParams": { # Parameters to specify for multi-node QueuedResource requests. This field must be populated in case of multi-node requests instead of node_id. It's an error to specify both node_id and multi_node_params. # Optional. Fields to specify in case of multi-node request. "nodeCount": 42, # Required. Number of nodes with this spec. The system will attempt to provison "node_count" nodes as part of the request. This needs to be > 1. "nodeIdPrefix": "A String", # Prefix of node_ids in case of multi-node request Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format. If node_count = 3 and node_id_prefix = "np", node ids of nodes created will be "np-0", "np-1", "np-2". If this field is not provided we use queued_resource_id as the node_id_prefix. + "workloadType": "A String", # Optional. The workload type for the multi-node request. }, "node": { # A TPU instance. # Required. The node. "acceleratorConfig": { # A TPU accelerator configuration. # The AccleratorConfig for the TPU Node. @@ -402,6 +403,7 @@

Method Details

"multiNodeParams": { # Parameters to specify for multi-node QueuedResource requests. This field must be populated in case of multi-node requests instead of node_id. It's an error to specify both node_id and multi_node_params. # Optional. Fields to specify in case of multi-node request. "nodeCount": 42, # Required. Number of nodes with this spec. The system will attempt to provison "node_count" nodes as part of the request. This needs to be > 1. "nodeIdPrefix": "A String", # Prefix of node_ids in case of multi-node request Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format. If node_count = 3 and node_id_prefix = "np", node ids of nodes created will be "np-0", "np-1", "np-2". If this field is not provided we use queued_resource_id as the node_id_prefix. + "workloadType": "A String", # Optional. The workload type for the multi-node request. }, "node": { # A TPU instance. # Required. The node. "acceleratorConfig": { # A TPU accelerator configuration. # The AccleratorConfig for the TPU Node. @@ -575,6 +577,7 @@

Method Details

"multiNodeParams": { # Parameters to specify for multi-node QueuedResource requests. This field must be populated in case of multi-node requests instead of node_id. It's an error to specify both node_id and multi_node_params. # Optional. Fields to specify in case of multi-node request. "nodeCount": 42, # Required. Number of nodes with this spec. The system will attempt to provison "node_count" nodes as part of the request. This needs to be > 1. "nodeIdPrefix": "A String", # Prefix of node_ids in case of multi-node request Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format. If node_count = 3 and node_id_prefix = "np", node ids of nodes created will be "np-0", "np-1", "np-2". If this field is not provided we use queued_resource_id as the node_id_prefix. + "workloadType": "A String", # Optional. The workload type for the multi-node request. }, "node": { # A TPU instance. # Required. The node. "acceleratorConfig": { # A TPU accelerator configuration. # The AccleratorConfig for the TPU Node. diff --git a/docs/dyn/transcoder_v1.projects.locations.jobTemplates.html b/docs/dyn/transcoder_v1.projects.locations.jobTemplates.html index 32ddc4fc70..2c36516e2e 100644 --- a/docs/dyn/transcoder_v1.projects.locations.jobTemplates.html +++ b/docs/dyn/transcoder_v1.projects.locations.jobTemplates.html @@ -132,7 +132,7 @@

Method Details

"channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency "A String", ], - "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` + "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` - `vorbis` "displayName": "A String", # The name for this particular audio stream that will be added to the HLS/DASH manifest. Not supported in MP4 files. "languageCode": "A String", # The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Not supported in MP4 files. "mapping": [ # The mapping for the JobConfig.edit_list atoms with audio EditAtom.inputs. @@ -326,7 +326,7 @@

Method Details

], "muxStreams": [ # List of multiplexing settings for output streams. { # Multiplexing settings for output stream. - "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) + "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` - `ogg` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) "elementaryStreams": [ # List of ElementaryStream.key values multiplexed in this stream. "A String", ], @@ -439,7 +439,7 @@

Method Details

"channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency "A String", ], - "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` + "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` - `vorbis` "displayName": "A String", # The name for this particular audio stream that will be added to the HLS/DASH manifest. Not supported in MP4 files. "languageCode": "A String", # The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Not supported in MP4 files. "mapping": [ # The mapping for the JobConfig.edit_list atoms with audio EditAtom.inputs. @@ -633,7 +633,7 @@

Method Details

], "muxStreams": [ # List of multiplexing settings for output streams. { # Multiplexing settings for output stream. - "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) + "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` - `ogg` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) "elementaryStreams": [ # List of ElementaryStream.key values multiplexed in this stream. "A String", ], @@ -771,7 +771,7 @@

Method Details

"channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency "A String", ], - "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` + "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` - `vorbis` "displayName": "A String", # The name for this particular audio stream that will be added to the HLS/DASH manifest. Not supported in MP4 files. "languageCode": "A String", # The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Not supported in MP4 files. "mapping": [ # The mapping for the JobConfig.edit_list atoms with audio EditAtom.inputs. @@ -965,7 +965,7 @@

Method Details

], "muxStreams": [ # List of multiplexing settings for output streams. { # Multiplexing settings for output stream. - "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) + "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` - `ogg` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) "elementaryStreams": [ # List of ElementaryStream.key values multiplexed in this stream. "A String", ], @@ -1090,7 +1090,7 @@

Method Details

"channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency "A String", ], - "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` + "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` - `vorbis` "displayName": "A String", # The name for this particular audio stream that will be added to the HLS/DASH manifest. Not supported in MP4 files. "languageCode": "A String", # The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Not supported in MP4 files. "mapping": [ # The mapping for the JobConfig.edit_list atoms with audio EditAtom.inputs. @@ -1284,7 +1284,7 @@

Method Details

], "muxStreams": [ # List of multiplexing settings for output streams. { # Multiplexing settings for output stream. - "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) + "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` - `ogg` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) "elementaryStreams": [ # List of ElementaryStream.key values multiplexed in this stream. "A String", ], diff --git a/docs/dyn/transcoder_v1.projects.locations.jobs.html b/docs/dyn/transcoder_v1.projects.locations.jobs.html index 36542bcc27..2f1d9cab94 100644 --- a/docs/dyn/transcoder_v1.projects.locations.jobs.html +++ b/docs/dyn/transcoder_v1.projects.locations.jobs.html @@ -133,7 +133,7 @@

Method Details

"channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency "A String", ], - "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` + "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` - `vorbis` "displayName": "A String", # The name for this particular audio stream that will be added to the HLS/DASH manifest. Not supported in MP4 files. "languageCode": "A String", # The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Not supported in MP4 files. "mapping": [ # The mapping for the JobConfig.edit_list atoms with audio EditAtom.inputs. @@ -327,7 +327,7 @@

Method Details

], "muxStreams": [ # List of multiplexing settings for output streams. { # Multiplexing settings for output stream. - "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) + "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` - `ogg` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) "elementaryStreams": [ # List of ElementaryStream.key values multiplexed in this stream. "A String", ], @@ -459,7 +459,7 @@

Method Details

"channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency "A String", ], - "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` + "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` - `vorbis` "displayName": "A String", # The name for this particular audio stream that will be added to the HLS/DASH manifest. Not supported in MP4 files. "languageCode": "A String", # The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Not supported in MP4 files. "mapping": [ # The mapping for the JobConfig.edit_list atoms with audio EditAtom.inputs. @@ -653,7 +653,7 @@

Method Details

], "muxStreams": [ # List of multiplexing settings for output streams. { # Multiplexing settings for output stream. - "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) + "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` - `ogg` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) "elementaryStreams": [ # List of ElementaryStream.key values multiplexed in this stream. "A String", ], @@ -811,7 +811,7 @@

Method Details

"channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency "A String", ], - "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` + "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` - `vorbis` "displayName": "A String", # The name for this particular audio stream that will be added to the HLS/DASH manifest. Not supported in MP4 files. "languageCode": "A String", # The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Not supported in MP4 files. "mapping": [ # The mapping for the JobConfig.edit_list atoms with audio EditAtom.inputs. @@ -1005,7 +1005,7 @@

Method Details

], "muxStreams": [ # List of multiplexing settings for output streams. { # Multiplexing settings for output stream. - "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) + "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` - `ogg` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) "elementaryStreams": [ # List of ElementaryStream.key values multiplexed in this stream. "A String", ], @@ -1150,7 +1150,7 @@

Method Details

"channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency "A String", ], - "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` + "codec": "A String", # The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` - `vorbis` "displayName": "A String", # The name for this particular audio stream that will be added to the HLS/DASH manifest. Not supported in MP4 files. "languageCode": "A String", # The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Not supported in MP4 files. "mapping": [ # The mapping for the JobConfig.edit_list atoms with audio EditAtom.inputs. @@ -1344,7 +1344,7 @@

Method Details

], "muxStreams": [ # List of multiplexing settings for output streams. { # Multiplexing settings for output stream. - "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) + "container": "A String", # The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` - `ogg` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) "elementaryStreams": [ # List of ElementaryStream.key values multiplexed in this stream. "A String", ], diff --git a/docs/dyn/travelimpactmodel_v1.flights.html b/docs/dyn/travelimpactmodel_v1.flights.html index f60a4a2d3f..7867216229 100644 --- a/docs/dyn/travelimpactmodel_v1.flights.html +++ b/docs/dyn/travelimpactmodel_v1.flights.html @@ -121,7 +121,7 @@

Method Details

{ # Output definition for the ComputeFlightEmissions response. "flightEmissions": [ # List of flight legs with emission estimates. { # Direct flight with emission estimates. - "emissionsGramsPerPax": { # Grouped emissions per seating class results. # Optional. Per-passenger emission estimate numbers. Will not be present if emissions could not be computed. For the list of reasons why emissions could not be computed, see ComputeFlightEmissions. Note this field is currently equivalent to ttw_emissions_grams_per_pax until TIM version 1.X.0 which will update this to be total wtw emissions aka wtt_emissions_grams_per_pax + ttw_emissions_grams_per_pax. + "emissionsGramsPerPax": { # Grouped emissions per seating class results. # Optional. Per-passenger emission estimate numbers. Will not be present if emissions could not be computed. For the list of reasons why emissions could not be computed, see ComputeFlightEmissions. This field uses wtw emissions aka ttw_emissions_grams_per_pax + wtt_emissions_grams_per_pax. "business": 42, # Emissions for one passenger in business class in grams. This field is always computed and populated, regardless of whether the aircraft has business class seats or not. "economy": 42, # Emissions for one passenger in economy class in grams. This field is always computed and populated, regardless of whether the aircraft has economy class seats or not. "first": 42, # Emissions for one passenger in first class in grams. This field is always computed and populated, regardless of whether the aircraft has first class seats or not. diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.html b/docs/dyn/vmmigration_v1.projects.locations.sources.html index dd8b6a9012..81bed1ed54 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.html @@ -324,6 +324,7 @@

Method Details

"azureVms": { # AzureVmsDetails describes VMs in Azure. # The description of the VMs in a Source of type Azure. "details": [ # The details of the Azure VMs. { # AzureVmDetails describes a VM in Azure. + "architecture": "A String", # The CPU architecture. "bootOption": "A String", # The VM Boot Option. "committedStorageMb": "A String", # The total size of the storage allocated to the VM in MB. "computerName": "A String", # The VM's ComputerName. @@ -362,6 +363,7 @@

Method Details

"vmwareVms": { # VmwareVmsDetails describes VMs in vCenter. # The description of the VMs in a Source of type Vmware. "details": [ # The details of the vmware VMs. { # VmwareVmDetails describes a VM in vCenter. + "architecture": "A String", # Output only. The CPU architecture. "bootOption": "A String", # Output only. The VM Boot Option. "committedStorageMb": "A String", # The total size of the storage allocated to the VM in MB. "cpuCount": 42, # The number of cpus in the VM. diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html index 3fdd0d568c..1bd01384d6 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html @@ -139,6 +139,7 @@

Method Details

{ # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "awsSourceVmDetails": { # Represent the source AWS VM details. # Output only. Details of the VM from an AWS source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of an AWS instance disk. @@ -156,6 +157,7 @@

Method Details

}, }, "azureSourceVmDetails": { # Represent the source Azure VM details. # Output only. Details of the VM from an Azure source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of an Azure VM disk. @@ -763,6 +765,7 @@

Method Details

"stateTime": "A String", # Output only. The last time the migrating VM state was updated. "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. "vmwareSourceVmDetails": { # Represent the source Vmware VM details. # Output only. Details of the VM from a Vmware source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of a Vmware VM disk. @@ -909,6 +912,7 @@

Method Details

{ # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "awsSourceVmDetails": { # Represent the source AWS VM details. # Output only. Details of the VM from an AWS source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of an AWS instance disk. @@ -926,6 +930,7 @@

Method Details

}, }, "azureSourceVmDetails": { # Represent the source Azure VM details. # Output only. Details of the VM from an Azure source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of an Azure VM disk. @@ -1533,6 +1538,7 @@

Method Details

"stateTime": "A String", # Output only. The last time the migrating VM state was updated. "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. "vmwareSourceVmDetails": { # Represent the source Vmware VM details. # Output only. Details of the VM from a Vmware source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of a Vmware VM disk. @@ -1579,6 +1585,7 @@

Method Details

"migratingVms": [ # Output only. The list of Migrating VMs response. { # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "awsSourceVmDetails": { # Represent the source AWS VM details. # Output only. Details of the VM from an AWS source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of an AWS instance disk. @@ -1596,6 +1603,7 @@

Method Details

}, }, "azureSourceVmDetails": { # Represent the source Azure VM details. # Output only. Details of the VM from an Azure source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of an Azure VM disk. @@ -2203,6 +2211,7 @@

Method Details

"stateTime": "A String", # Output only. The last time the migrating VM state was updated. "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. "vmwareSourceVmDetails": { # Represent the source Vmware VM details. # Output only. Details of the VM from a Vmware source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of a Vmware VM disk. @@ -2253,6 +2262,7 @@

Method Details

{ # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "awsSourceVmDetails": { # Represent the source AWS VM details. # Output only. Details of the VM from an AWS source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of an AWS instance disk. @@ -2270,6 +2280,7 @@

Method Details

}, }, "azureSourceVmDetails": { # Represent the source Azure VM details. # Output only. Details of the VM from an Azure source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of an Azure VM disk. @@ -2877,6 +2888,7 @@

Method Details

"stateTime": "A String", # Output only. The last time the migrating VM state was updated. "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. "vmwareSourceVmDetails": { # Represent the source Vmware VM details. # Output only. Details of the VM from a Vmware source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of a Vmware VM disk. diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.utilizationReports.html b/docs/dyn/vmmigration_v1.projects.locations.sources.utilizationReports.html index 5b1271dd54..b0e28dc2a6 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.utilizationReports.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.utilizationReports.html @@ -139,6 +139,7 @@

Method Details

}, "vmId": "A String", # The VM's ID in the source. "vmwareVmDetails": { # VmwareVmDetails describes a VM in vCenter. # The description of the VM in a Source of type Vmware. + "architecture": "A String", # Output only. The CPU architecture. "bootOption": "A String", # Output only. The VM Boot Option. "committedStorageMb": "A String", # The total size of the storage allocated to the VM in MB. "cpuCount": 42, # The number of cpus in the VM. @@ -274,6 +275,7 @@

Method Details

}, "vmId": "A String", # The VM's ID in the source. "vmwareVmDetails": { # VmwareVmDetails describes a VM in vCenter. # The description of the VM in a Source of type Vmware. + "architecture": "A String", # Output only. The CPU architecture. "bootOption": "A String", # Output only. The VM Boot Option. "committedStorageMb": "A String", # The total size of the storage allocated to the VM in MB. "cpuCount": 42, # The number of cpus in the VM. @@ -353,6 +355,7 @@

Method Details

}, "vmId": "A String", # The VM's ID in the source. "vmwareVmDetails": { # VmwareVmDetails describes a VM in vCenter. # The description of the VM in a Source of type Vmware. + "architecture": "A String", # Output only. The CPU architecture. "bootOption": "A String", # Output only. The VM Boot Option. "committedStorageMb": "A String", # The total size of the storage allocated to the VM in MB. "cpuCount": 42, # The number of cpus in the VM. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.html index f5e1c7495e..1507cb85a4 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.html @@ -333,6 +333,7 @@

Method Details

"azureVms": { # AzureVmsDetails describes VMs in Azure. # The description of the VMs in a Source of type Azure. "details": [ # The details of the Azure VMs. { # AzureVmDetails describes a VM in Azure. + "architecture": "A String", # The CPU architecture. "bootOption": "A String", # The VM Boot Option. "committedStorageMb": "A String", # The total size of the storage allocated to the VM in MB. "computerName": "A String", # The VM's ComputerName. @@ -371,6 +372,7 @@

Method Details

"vmwareVms": { # VmwareVmsDetails describes VMs in vCenter. # The description of the VMs in a Source of type Vmware. "details": [ # The details of the vmware VMs. { # VmwareVmDetails describes a VM in vCenter. + "architecture": "A String", # Output only. The CPU architecture. "bootOption": "A String", # Output only. The VM Boot Option. "committedStorage": "A String", # The total size of the storage allocated to the VM in MB. "committedStorageMb": "A String", # The total size of the storage allocated to the VM in MB. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html index dbb5b92536..f784dcdc4a 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html @@ -139,6 +139,7 @@

Method Details

{ # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "awsSourceVmDetails": { # Represent the source AWS VM details. # Output only. Details of the VM from an AWS source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of an AWS instance disk. @@ -156,6 +157,7 @@

Method Details

}, }, "azureSourceVmDetails": { # Represent the source Azure VM details. # Output only. Details of the VM from an Azure source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of an Azure VM disk. @@ -1096,6 +1098,7 @@

Method Details

}, "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. "vmwareSourceVmDetails": { # Represent the source Vmware VM details. # Output only. Details of the VM from a Vmware source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of a Vmware VM disk. @@ -1242,6 +1245,7 @@

Method Details

{ # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "awsSourceVmDetails": { # Represent the source AWS VM details. # Output only. Details of the VM from an AWS source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of an AWS instance disk. @@ -1259,6 +1263,7 @@

Method Details

}, }, "azureSourceVmDetails": { # Represent the source Azure VM details. # Output only. Details of the VM from an Azure source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of an Azure VM disk. @@ -2199,6 +2204,7 @@

Method Details

}, "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. "vmwareSourceVmDetails": { # Represent the source Vmware VM details. # Output only. Details of the VM from a Vmware source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of a Vmware VM disk. @@ -2245,6 +2251,7 @@

Method Details

"migratingVms": [ # Output only. The list of Migrating VMs response. { # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "awsSourceVmDetails": { # Represent the source AWS VM details. # Output only. Details of the VM from an AWS source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of an AWS instance disk. @@ -2262,6 +2269,7 @@

Method Details

}, }, "azureSourceVmDetails": { # Represent the source Azure VM details. # Output only. Details of the VM from an Azure source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of an Azure VM disk. @@ -3202,6 +3210,7 @@

Method Details

}, "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. "vmwareSourceVmDetails": { # Represent the source Vmware VM details. # Output only. Details of the VM from a Vmware source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of a Vmware VM disk. @@ -3252,6 +3261,7 @@

Method Details

{ # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "awsSourceVmDetails": { # Represent the source AWS VM details. # Output only. Details of the VM from an AWS source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of an AWS instance disk. @@ -3269,6 +3279,7 @@

Method Details

}, }, "azureSourceVmDetails": { # Represent the source Azure VM details. # Output only. Details of the VM from an Azure source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of an Azure VM disk. @@ -4209,6 +4220,7 @@

Method Details

}, "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. "vmwareSourceVmDetails": { # Represent the source Vmware VM details. # Output only. Details of the VM from a Vmware source. + "architecture": "A String", # Output only. The VM architecture. "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. "disks": [ # Output only. The disks attached to the source VM. { # The details of a Vmware VM disk. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.utilizationReports.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.utilizationReports.html index ce2b1eecf5..d6d0675502 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.utilizationReports.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.utilizationReports.html @@ -147,6 +147,7 @@

Method Details

}, "vmId": "A String", # The VM's ID in the source. "vmwareVmDetails": { # VmwareVmDetails describes a VM in vCenter. # The description of the VM in a Source of type Vmware. + "architecture": "A String", # Output only. The CPU architecture. "bootOption": "A String", # Output only. The VM Boot Option. "committedStorage": "A String", # The total size of the storage allocated to the VM in MB. "committedStorageMb": "A String", # The total size of the storage allocated to the VM in MB. @@ -292,6 +293,7 @@

Method Details

}, "vmId": "A String", # The VM's ID in the source. "vmwareVmDetails": { # VmwareVmDetails describes a VM in vCenter. # The description of the VM in a Source of type Vmware. + "architecture": "A String", # Output only. The CPU architecture. "bootOption": "A String", # Output only. The VM Boot Option. "committedStorage": "A String", # The total size of the storage allocated to the VM in MB. "committedStorageMb": "A String", # The total size of the storage allocated to the VM in MB. @@ -381,6 +383,7 @@

Method Details

}, "vmId": "A String", # The VM's ID in the source. "vmwareVmDetails": { # VmwareVmDetails describes a VM in vCenter. # The description of the VM in a Source of type Vmware. + "architecture": "A String", # Output only. The CPU architecture. "bootOption": "A String", # Output only. The VM Boot Option. "committedStorage": "A String", # The total size of the storage allocated to the VM in MB. "committedStorageMb": "A String", # The total size of the storage allocated to the VM in MB. diff --git a/docs/dyn/vmwareengine_v1.projects.locations.networkPeerings.html b/docs/dyn/vmwareengine_v1.projects.locations.networkPeerings.html index 0ea8a2851d..96acc1534b 100644 --- a/docs/dyn/vmwareengine_v1.projects.locations.networkPeerings.html +++ b/docs/dyn/vmwareengine_v1.projects.locations.networkPeerings.html @@ -123,7 +123,7 @@

Method Details

"exportCustomRoutesWithPublicIp": True or False, # Optional. True if all subnet routes with a public IP address range are exported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. "importCustomRoutes": True or False, # Optional. True if custom routes are imported from the peered network; false otherwise. The default value is true. "importCustomRoutesWithPublicIp": True or False, # Optional. True if all subnet routes with public IP address range are imported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported to peers and are not controlled by this field. - "name": "A String", # Output only. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/networkPeerings/my-peering` + "name": "A String", # Output only. Identifier. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/networkPeerings/my-peering` "peerMtu": 42, # Optional. Maximum transmission unit (MTU) in bytes. The default value is `1500`. If a value of `0` is provided for this field, VMware Engine uses the default value instead. "peerNetwork": "A String", # Required. The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network. If the `peer_network_type` is VMWARE_ENGINE_NETWORK, specify the name in the form: `projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id}`. Otherwise specify the name in the form: `projects/{project}/global/networks/{network_id}`, where `{project}` can either be a project number or a project ID. "peerNetworkType": "A String", # Required. The type of the network to peer with the VMware Engine network. @@ -223,7 +223,7 @@

Method Details

"exportCustomRoutesWithPublicIp": True or False, # Optional. True if all subnet routes with a public IP address range are exported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. "importCustomRoutes": True or False, # Optional. True if custom routes are imported from the peered network; false otherwise. The default value is true. "importCustomRoutesWithPublicIp": True or False, # Optional. True if all subnet routes with public IP address range are imported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported to peers and are not controlled by this field. - "name": "A String", # Output only. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/networkPeerings/my-peering` + "name": "A String", # Output only. Identifier. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/networkPeerings/my-peering` "peerMtu": 42, # Optional. Maximum transmission unit (MTU) in bytes. The default value is `1500`. If a value of `0` is provided for this field, VMware Engine uses the default value instead. "peerNetwork": "A String", # Required. The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network. If the `peer_network_type` is VMWARE_ENGINE_NETWORK, specify the name in the form: `projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id}`. Otherwise specify the name in the form: `projects/{project}/global/networks/{network_id}`, where `{project}` can either be a project number or a project ID. "peerNetworkType": "A String", # Required. The type of the network to peer with the VMware Engine network. @@ -263,7 +263,7 @@

Method Details

"exportCustomRoutesWithPublicIp": True or False, # Optional. True if all subnet routes with a public IP address range are exported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. "importCustomRoutes": True or False, # Optional. True if custom routes are imported from the peered network; false otherwise. The default value is true. "importCustomRoutesWithPublicIp": True or False, # Optional. True if all subnet routes with public IP address range are imported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported to peers and are not controlled by this field. - "name": "A String", # Output only. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/networkPeerings/my-peering` + "name": "A String", # Output only. Identifier. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/networkPeerings/my-peering` "peerMtu": 42, # Optional. Maximum transmission unit (MTU) in bytes. The default value is `1500`. If a value of `0` is provided for this field, VMware Engine uses the default value instead. "peerNetwork": "A String", # Required. The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network. If the `peer_network_type` is VMWARE_ENGINE_NETWORK, specify the name in the form: `projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id}`. Otherwise specify the name in the form: `projects/{project}/global/networks/{network_id}`, where `{project}` can either be a project number or a project ID. "peerNetworkType": "A String", # Required. The type of the network to peer with the VMware Engine network. @@ -300,7 +300,7 @@

Method Details

Modifies a `NetworkPeering` resource. Only the `description` field can be updated. Only fields specified in `updateMask` are applied. NetworkPeering is a global resource and location can only be global.
 
 Args:
-  name: string, Output only. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/networkPeerings/my-peering` (required)
+  name: string, Output only. Identifier. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/networkPeerings/my-peering` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -312,7 +312,7 @@ 

Method Details

"exportCustomRoutesWithPublicIp": True or False, # Optional. True if all subnet routes with a public IP address range are exported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. "importCustomRoutes": True or False, # Optional. True if custom routes are imported from the peered network; false otherwise. The default value is true. "importCustomRoutesWithPublicIp": True or False, # Optional. True if all subnet routes with public IP address range are imported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported to peers and are not controlled by this field. - "name": "A String", # Output only. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/networkPeerings/my-peering` + "name": "A String", # Output only. Identifier. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/networkPeerings/my-peering` "peerMtu": 42, # Optional. Maximum transmission unit (MTU) in bytes. The default value is `1500`. If a value of `0` is provided for this field, VMware Engine uses the default value instead. "peerNetwork": "A String", # Required. The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network. If the `peer_network_type` is VMWARE_ENGINE_NETWORK, specify the name in the form: `projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id}`. Otherwise specify the name in the form: `projects/{project}/global/networks/{network_id}`, where `{project}` can either be a project number or a project ID. "peerNetworkType": "A String", # Required. The type of the network to peer with the VMware Engine network. diff --git a/docs/dyn/vmwareengine_v1.projects.locations.networkPolicies.html b/docs/dyn/vmwareengine_v1.projects.locations.networkPolicies.html index 6c55404b9d..9aad24fdf8 100644 --- a/docs/dyn/vmwareengine_v1.projects.locations.networkPolicies.html +++ b/docs/dyn/vmwareengine_v1.projects.locations.networkPolicies.html @@ -133,7 +133,7 @@

Method Details

"enabled": True or False, # True if the service is enabled; false otherwise. "state": "A String", # Output only. State of the service. New values may be added to this enum when appropriate. }, - "name": "A String", # Output only. The resource name of this network policy. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` + "name": "A String", # Output only. Identifier. The resource name of this network policy. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` "uid": "A String", # Output only. System-generated unique identifier for the resource. "updateTime": "A String", # Output only. Last update time of this resource. "vmwareEngineNetwork": "A String", # Optional. The relative resource name of the VMware Engine network. Specify the name in the following form: `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` where `{project}` can either be a project number or a project ID. @@ -230,7 +230,7 @@

Method Details

"description": "A String", # User-provided description for this resource. "externalIp": "A String", # Output only. The external IP address of a workload VM. "internalIp": "A String", # The internal IP address of a workload VM. - "name": "A String", # Output only. The resource name of this external IP address. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address` + "name": "A String", # Output only. Identifier. The resource name of this external IP address. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address` "state": "A String", # Output only. The state of the resource. "uid": "A String", # Output only. System-generated unique identifier for the resource. "updateTime": "A String", # Output only. Last update time of this resource. @@ -280,7 +280,7 @@

Method Details

"enabled": True or False, # True if the service is enabled; false otherwise. "state": "A String", # Output only. State of the service. New values may be added to this enum when appropriate. }, - "name": "A String", # Output only. The resource name of this network policy. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` + "name": "A String", # Output only. Identifier. The resource name of this network policy. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` "uid": "A String", # Output only. System-generated unique identifier for the resource. "updateTime": "A String", # Output only. Last update time of this resource. "vmwareEngineNetwork": "A String", # Optional. The relative resource name of the VMware Engine network. Specify the name in the following form: `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` where `{project}` can either be a project number or a project ID. @@ -320,7 +320,7 @@

Method Details

"enabled": True or False, # True if the service is enabled; false otherwise. "state": "A String", # Output only. State of the service. New values may be added to this enum when appropriate. }, - "name": "A String", # Output only. The resource name of this network policy. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` + "name": "A String", # Output only. Identifier. The resource name of this network policy. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` "uid": "A String", # Output only. System-generated unique identifier for the resource. "updateTime": "A String", # Output only. Last update time of this resource. "vmwareEngineNetwork": "A String", # Optional. The relative resource name of the VMware Engine network. Specify the name in the following form: `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` where `{project}` can either be a project number or a project ID. @@ -353,7 +353,7 @@

Method Details

Modifies a `NetworkPolicy` resource. Only the following fields can be updated: `internet_access`, `external_ip`, `edge_services_cidr`. Only fields specified in `updateMask` are applied. When updating a network policy, the external IP network service can only be disabled if there are no external IP addresses present in the scope of the policy. Also, a `NetworkService` cannot be updated when `NetworkService.state` is set to `RECONCILING`. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.
 
 Args:
-  name: string, Output only. The resource name of this network policy. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` (required)
+  name: string, Output only. Identifier. The resource name of this network policy. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -369,7 +369,7 @@ 

Method Details

"enabled": True or False, # True if the service is enabled; false otherwise. "state": "A String", # Output only. State of the service. New values may be added to this enum when appropriate. }, - "name": "A String", # Output only. The resource name of this network policy. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` + "name": "A String", # Output only. Identifier. The resource name of this network policy. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` "uid": "A String", # Output only. System-generated unique identifier for the resource. "updateTime": "A String", # Output only. Last update time of this resource. "vmwareEngineNetwork": "A String", # Optional. The relative resource name of the VMware Engine network. Specify the name in the following form: `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` where `{project}` can either be a project number or a project ID. diff --git a/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.clusters.html b/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.clusters.html index 968f90e2d9..a519d80d46 100644 --- a/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.clusters.html +++ b/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.clusters.html @@ -154,7 +154,7 @@

Method Details

}, "createTime": "A String", # Output only. Creation time of this resource. "management": True or False, # Output only. True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one. - "name": "A String", # Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster` + "name": "A String", # Output only. Identifier. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster` "nodeTypeConfigs": { # Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the `NodeType`). "a_key": { # Information about the type and number of nodes associated with the cluster. "customCoreCount": 42, # Optional. Customized number of cores available to each node of the type. This number must always be one of `nodeType.availableCustomCoreCounts`. If zero is provided max value from `nodeType.availableCustomCoreCounts` will be used. @@ -282,7 +282,7 @@

Method Details

}, "createTime": "A String", # Output only. Creation time of this resource. "management": True or False, # Output only. True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one. - "name": "A String", # Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster` + "name": "A String", # Output only. Identifier. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster` "nodeTypeConfigs": { # Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the `NodeType`). "a_key": { # Information about the type and number of nodes associated with the cluster. "customCoreCount": 42, # Optional. Customized number of cores available to each node of the type. This number must always be one of `nodeType.availableCustomCoreCounts`. If zero is provided max value from `nodeType.availableCustomCoreCounts` will be used. @@ -397,7 +397,7 @@

Method Details

}, "createTime": "A String", # Output only. Creation time of this resource. "management": True or False, # Output only. True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one. - "name": "A String", # Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster` + "name": "A String", # Output only. Identifier. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster` "nodeTypeConfigs": { # Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the `NodeType`). "a_key": { # Information about the type and number of nodes associated with the cluster. "customCoreCount": 42, # Optional. Customized number of cores available to each node of the type. This number must always be one of `nodeType.availableCustomCoreCounts`. If zero is provided max value from `nodeType.availableCustomCoreCounts` will be used. @@ -439,7 +439,7 @@

Method Details

Modifies a `Cluster` resource. Only fields specified in `updateMask` are applied. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.
 
 Args:
-  name: string, Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster` (required)
+  name: string, Output only. Identifier. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -473,7 +473,7 @@ 

Method Details

}, "createTime": "A String", # Output only. Creation time of this resource. "management": True or False, # Output only. True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one. - "name": "A String", # Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster` + "name": "A String", # Output only. Identifier. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster` "nodeTypeConfigs": { # Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the `NodeType`). "a_key": { # Information about the type and number of nodes associated with the cluster. "customCoreCount": 42, # Optional. Customized number of cores available to each node of the type. This number must always be one of `nodeType.availableCustomCoreCounts`. If zero is provided max value from `nodeType.availableCustomCoreCounts` will be used. diff --git a/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.externalAddresses.html b/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.externalAddresses.html index fda28cc7e8..06a1b2c9a6 100644 --- a/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.externalAddresses.html +++ b/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.externalAddresses.html @@ -115,7 +115,7 @@

Method Details

"description": "A String", # User-provided description for this resource. "externalIp": "A String", # Output only. The external IP address of a workload VM. "internalIp": "A String", # The internal IP address of a workload VM. - "name": "A String", # Output only. The resource name of this external IP address. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address` + "name": "A String", # Output only. Identifier. The resource name of this external IP address. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address` "state": "A String", # Output only. The state of the resource. "uid": "A String", # Output only. System-generated unique identifier for the resource. "updateTime": "A String", # Output only. Last update time of this resource. @@ -207,7 +207,7 @@

Method Details

"description": "A String", # User-provided description for this resource. "externalIp": "A String", # Output only. The external IP address of a workload VM. "internalIp": "A String", # The internal IP address of a workload VM. - "name": "A String", # Output only. The resource name of this external IP address. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address` + "name": "A String", # Output only. Identifier. The resource name of this external IP address. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address` "state": "A String", # Output only. The state of the resource. "uid": "A String", # Output only. System-generated unique identifier for the resource. "updateTime": "A String", # Output only. Last update time of this resource. @@ -239,7 +239,7 @@

Method Details

"description": "A String", # User-provided description for this resource. "externalIp": "A String", # Output only. The external IP address of a workload VM. "internalIp": "A String", # The internal IP address of a workload VM. - "name": "A String", # Output only. The resource name of this external IP address. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address` + "name": "A String", # Output only. Identifier. The resource name of this external IP address. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address` "state": "A String", # Output only. The state of the resource. "uid": "A String", # Output only. System-generated unique identifier for the resource. "updateTime": "A String", # Output only. Last update time of this resource. @@ -271,7 +271,7 @@

Method Details

Updates the parameters of a single external IP address. Only fields specified in `update_mask` are applied. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.
 
 Args:
-  name: string, Output only. The resource name of this external IP address. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address` (required)
+  name: string, Output only. Identifier. The resource name of this external IP address. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -280,7 +280,7 @@ 

Method Details

"description": "A String", # User-provided description for this resource. "externalIp": "A String", # Output only. The external IP address of a workload VM. "internalIp": "A String", # The internal IP address of a workload VM. - "name": "A String", # Output only. The resource name of this external IP address. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address` + "name": "A String", # Output only. Identifier. The resource name of this external IP address. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address` "state": "A String", # Output only. The state of the resource. "uid": "A String", # Output only. System-generated unique identifier for the resource. "updateTime": "A String", # Output only. Last update time of this resource. diff --git a/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.html b/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.html index d7bf116617..0bf9864670 100644 --- a/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.html +++ b/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.html @@ -194,7 +194,7 @@

Method Details

"secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` where `{project}` can either be a project number or a project ID. }, }, - "name": "A String", # Output only. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` + "name": "A String", # Output only. Identifier. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` "networkConfig": { # Network configuration in the consumer project with which the peering has to be done. # Required. Network configuration of the private cloud. "dnsServerIp": "A String", # Output only. DNS Server IP of the Private Cloud. All DNS queries can be forwarded to this address for name resolution of Private Cloud's management entities like vCenter, NSX-T Manager and ESXi hosts. "managementCidr": "A String", # Required. Management CIDR used by VMware management appliances. @@ -328,7 +328,7 @@

Method Details

"secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` where `{project}` can either be a project number or a project ID. }, }, - "name": "A String", # Output only. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` + "name": "A String", # Output only. Identifier. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` "networkConfig": { # Network configuration in the consumer project with which the peering has to be done. # Required. Network configuration of the private cloud. "dnsServerIp": "A String", # Output only. DNS Server IP of the Private Cloud. All DNS queries can be forwarded to this address for name resolution of Private Cloud's management entities like vCenter, NSX-T Manager and ESXi hosts. "managementCidr": "A String", # Required. Management CIDR used by VMware management appliances. @@ -379,7 +379,7 @@

Method Details

], }, ], - "name": "A String", # Output only. The resource name of this DNS profile. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/dnsForwarding` + "name": "A String", # Output only. Identifier. The resource name of this DNS profile. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/dnsForwarding` "updateTime": "A String", # Output only. Last update time of this resource. }
@@ -477,7 +477,7 @@

Method Details

"secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` where `{project}` can either be a project number or a project ID. }, }, - "name": "A String", # Output only. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` + "name": "A String", # Output only. Identifier. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` "networkConfig": { # Network configuration in the consumer project with which the peering has to be done. # Required. Network configuration of the private cloud. "dnsServerIp": "A String", # Output only. DNS Server IP of the Private Cloud. All DNS queries can be forwarded to this address for name resolution of Private Cloud's management entities like vCenter, NSX-T Manager and ESXi hosts. "managementCidr": "A String", # Required. Management CIDR used by VMware management appliances. @@ -528,7 +528,7 @@

Method Details

Modifies a `PrivateCloud` resource. Only the following fields can be updated: `description`. Only fields specified in `updateMask` are applied. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.
 
 Args:
-  name: string, Output only. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` (required)
+  name: string, Output only. Identifier. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -556,7 +556,7 @@ 

Method Details

"secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` where `{project}` can either be a project number or a project ID. }, }, - "name": "A String", # Output only. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` + "name": "A String", # Output only. Identifier. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` "networkConfig": { # Network configuration in the consumer project with which the peering has to be done. # Required. Network configuration of the private cloud. "dnsServerIp": "A String", # Output only. DNS Server IP of the Private Cloud. All DNS queries can be forwarded to this address for name resolution of Private Cloud's management entities like vCenter, NSX-T Manager and ESXi hosts. "managementCidr": "A String", # Required. Management CIDR used by VMware management appliances. @@ -901,7 +901,7 @@

Method Details

Updates the parameters of the `DnsForwarding` config, like associated domains. Only fields specified in `update_mask` are applied.
 
 Args:
-  name: string, Output only. The resource name of this DNS profile. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/dnsForwarding` (required)
+  name: string, Output only. Identifier. The resource name of this DNS profile. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/dnsForwarding` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -915,7 +915,7 @@ 

Method Details

], }, ], - "name": "A String", # Output only. The resource name of this DNS profile. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/dnsForwarding` + "name": "A String", # Output only. Identifier. The resource name of this DNS profile. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/dnsForwarding` "updateTime": "A String", # Output only. Last update time of this resource. } diff --git a/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.subnets.html b/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.subnets.html index 1f397f796f..9e8990484e 100644 --- a/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.subnets.html +++ b/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.subnets.html @@ -112,7 +112,7 @@

Method Details

{ # Subnet in a private cloud. Either `management` subnets (such as vMotion) that are read-only, or `userDefined`, which can also be updated. "gatewayIp": "A String", # The IP address of the gateway of this subnet. Must fall within the IP prefix defined above. "ipCidrRange": "A String", # The IP address range of the subnet in CIDR format '10.0.0.0/24'. - "name": "A String", # Output only. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet` + "name": "A String", # Output only. Identifier. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet` "state": "A String", # Output only. The state of the resource. "type": "A String", # Output only. The type of the subnet. For example "management" or "userDefined". "vlanId": 42, # Output only. VLAN ID of the VLAN on which the subnet is configured @@ -141,7 +141,7 @@

Method Details

{ # Subnet in a private cloud. Either `management` subnets (such as vMotion) that are read-only, or `userDefined`, which can also be updated. "gatewayIp": "A String", # The IP address of the gateway of this subnet. Must fall within the IP prefix defined above. "ipCidrRange": "A String", # The IP address range of the subnet in CIDR format '10.0.0.0/24'. - "name": "A String", # Output only. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet` + "name": "A String", # Output only. Identifier. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet` "state": "A String", # Output only. The state of the resource. "type": "A String", # Output only. The type of the subnet. For example "management" or "userDefined". "vlanId": 42, # Output only. VLAN ID of the VLAN on which the subnet is configured @@ -172,14 +172,14 @@

Method Details

Updates the parameters of a single subnet. Only fields specified in `update_mask` are applied. *Note*: This API is synchronous and always returns a successful `google.longrunning.Operation` (LRO). The returned LRO will only have `done` and `response` fields.
 
 Args:
-  name: string, Output only. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet` (required)
+  name: string, Output only. Identifier. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet` (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Subnet in a private cloud. Either `management` subnets (such as vMotion) that are read-only, or `userDefined`, which can also be updated.
   "gatewayIp": "A String", # The IP address of the gateway of this subnet. Must fall within the IP prefix defined above.
   "ipCidrRange": "A String", # The IP address range of the subnet in CIDR format '10.0.0.0/24'.
-  "name": "A String", # Output only. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet`
+  "name": "A String", # Output only. Identifier. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet`
   "state": "A String", # Output only. The state of the resource.
   "type": "A String", # Output only. The type of the subnet. For example "management" or "userDefined".
   "vlanId": 42, # Output only. VLAN ID of the VLAN on which the subnet is configured
diff --git a/docs/dyn/vmwareengine_v1.projects.locations.vmwareEngineNetworks.html b/docs/dyn/vmwareengine_v1.projects.locations.vmwareEngineNetworks.html
index 1e29b25cce..7ac1bbdb97 100644
--- a/docs/dyn/vmwareengine_v1.projects.locations.vmwareEngineNetworks.html
+++ b/docs/dyn/vmwareengine_v1.projects.locations.vmwareEngineNetworks.html
@@ -114,7 +114,7 @@ 

Method Details

"createTime": "A String", # Output only. Creation time of this resource. "description": "A String", # User-provided description for this VMware Engine network. "etag": "A String", # Checksum that may be sent on update and delete requests to ensure that the user-provided value is up to date before the server processes a request. The server computes checksums based on the value of other fields in the request. - "name": "A String", # Output only. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network` + "name": "A String", # Output only. Identifier. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network` "state": "A String", # Output only. State of the VMware Engine network. "type": "A String", # Required. VMware Engine network type. "uid": "A String", # Output only. System-generated unique identifier for the resource. @@ -213,7 +213,7 @@

Method Details

"createTime": "A String", # Output only. Creation time of this resource. "description": "A String", # User-provided description for this VMware Engine network. "etag": "A String", # Checksum that may be sent on update and delete requests to ensure that the user-provided value is up to date before the server processes a request. The server computes checksums based on the value of other fields in the request. - "name": "A String", # Output only. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network` + "name": "A String", # Output only. Identifier. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network` "state": "A String", # Output only. State of the VMware Engine network. "type": "A String", # Required. VMware Engine network type. "uid": "A String", # Output only. System-generated unique identifier for the resource. @@ -255,7 +255,7 @@

Method Details

"createTime": "A String", # Output only. Creation time of this resource. "description": "A String", # User-provided description for this VMware Engine network. "etag": "A String", # Checksum that may be sent on update and delete requests to ensure that the user-provided value is up to date before the server processes a request. The server computes checksums based on the value of other fields in the request. - "name": "A String", # Output only. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network` + "name": "A String", # Output only. Identifier. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network` "state": "A String", # Output only. State of the VMware Engine network. "type": "A String", # Required. VMware Engine network type. "uid": "A String", # Output only. System-generated unique identifier for the resource. @@ -290,7 +290,7 @@

Method Details

Modifies a VMware Engine network resource. Only the following fields can be updated: `description`. Only fields specified in `updateMask` are applied.
 
 Args:
-  name: string, Output only. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network` (required)
+  name: string, Output only. Identifier. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -298,7 +298,7 @@ 

Method Details

"createTime": "A String", # Output only. Creation time of this resource. "description": "A String", # User-provided description for this VMware Engine network. "etag": "A String", # Checksum that may be sent on update and delete requests to ensure that the user-provided value is up to date before the server processes a request. The server computes checksums based on the value of other fields in the request. - "name": "A String", # Output only. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network` + "name": "A String", # Output only. Identifier. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network` "state": "A String", # Output only. State of the VMware Engine network. "type": "A String", # Required. VMware Engine network type. "uid": "A String", # Output only. System-generated unique identifier for the resource. diff --git a/docs/dyn/walletobjects_v1.eventticketclass.html b/docs/dyn/walletobjects_v1.eventticketclass.html index 376a20dd20..d52f4cc342 100644 --- a/docs/dyn/walletobjects_v1.eventticketclass.html +++ b/docs/dyn/walletobjects_v1.eventticketclass.html @@ -1076,6 +1076,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -2255,6 +2256,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -3422,6 +3424,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -4588,6 +4591,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -5770,6 +5774,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -6940,6 +6945,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -8106,6 +8112,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -9274,6 +9281,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -10440,6 +10448,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], diff --git a/docs/dyn/walletobjects_v1.eventticketobject.html b/docs/dyn/walletobjects_v1.eventticketobject.html index 4282b4bf0c..4e904fbcf7 100644 --- a/docs/dyn/walletobjects_v1.eventticketobject.html +++ b/docs/dyn/walletobjects_v1.eventticketobject.html @@ -1384,6 +1384,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -1851,6 +1852,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -3356,6 +3358,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -3823,6 +3826,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -5316,6 +5320,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -5783,6 +5788,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -7275,6 +7281,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -7742,6 +7749,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -9250,6 +9258,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -9717,6 +9726,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -11232,6 +11242,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -11699,6 +11710,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -13193,6 +13205,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -13660,6 +13673,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -15152,6 +15166,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -15619,6 +15634,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -17113,6 +17129,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -17580,6 +17597,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -19072,6 +19090,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -19539,6 +19558,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", diff --git a/docs/dyn/walletobjects_v1.flightclass.html b/docs/dyn/walletobjects_v1.flightclass.html index bf04dfc3b2..ccc1489e55 100644 --- a/docs/dyn/walletobjects_v1.flightclass.html +++ b/docs/dyn/walletobjects_v1.flightclass.html @@ -1211,6 +1211,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -2473,6 +2474,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -3723,6 +3725,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -4972,6 +4975,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -6237,6 +6241,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -7490,6 +7495,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -8739,6 +8745,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -9990,6 +9997,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -11239,6 +11247,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. diff --git a/docs/dyn/walletobjects_v1.flightobject.html b/docs/dyn/walletobjects_v1.flightobject.html index bd1b0a99a9..f9d3656937 100644 --- a/docs/dyn/walletobjects_v1.flightobject.html +++ b/docs/dyn/walletobjects_v1.flightobject.html @@ -1577,6 +1577,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -1984,6 +1985,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -3663,6 +3665,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -4070,6 +4073,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -5737,6 +5741,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -6144,6 +6149,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -7810,6 +7816,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -8217,6 +8224,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -9899,6 +9907,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -10306,6 +10315,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -11976,6 +11986,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -12383,6 +12394,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -14049,6 +14061,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -14456,6 +14469,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -16124,6 +16138,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -16531,6 +16546,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -18197,6 +18213,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -18604,6 +18621,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", diff --git a/docs/dyn/walletobjects_v1.giftcardclass.html b/docs/dyn/walletobjects_v1.giftcardclass.html index 7121aee232..f427ff1060 100644 --- a/docs/dyn/walletobjects_v1.giftcardclass.html +++ b/docs/dyn/walletobjects_v1.giftcardclass.html @@ -973,6 +973,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -2051,6 +2052,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -3117,6 +3119,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -4182,6 +4185,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -5263,6 +5267,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -6332,6 +6337,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -7397,6 +7403,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -8464,6 +8471,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -9529,6 +9537,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. diff --git a/docs/dyn/walletobjects_v1.giftcardobject.html b/docs/dyn/walletobjects_v1.giftcardobject.html index f4298a1bfd..05e640117d 100644 --- a/docs/dyn/walletobjects_v1.giftcardobject.html +++ b/docs/dyn/walletobjects_v1.giftcardobject.html @@ -1287,6 +1287,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -1748,6 +1749,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -3076,6 +3078,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -3537,6 +3540,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -4853,6 +4857,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -5314,6 +5319,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -6629,6 +6635,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -7090,6 +7097,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -8421,6 +8429,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -8882,6 +8891,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -10201,6 +10211,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -10662,6 +10673,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -11977,6 +11989,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -12438,6 +12451,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -13755,6 +13769,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -14216,6 +14231,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -15531,6 +15547,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -15992,6 +16009,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", diff --git a/docs/dyn/walletobjects_v1.jwt.html b/docs/dyn/walletobjects_v1.jwt.html index 2a55335ad6..5cbec8678e 100644 --- a/docs/dyn/walletobjects_v1.jwt.html +++ b/docs/dyn/walletobjects_v1.jwt.html @@ -1022,6 +1022,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -2486,6 +2487,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -2953,6 +2955,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -4268,6 +4271,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -5876,6 +5880,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "origin": { # Required. Origin airport. "airportIataCode": "A String", # Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO" "airportNameOverride": { # Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it. @@ -6283,6 +6288,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -8864,6 +8870,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -10236,6 +10243,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "pinLabel": "A String", # The label to display for the PIN, such as "4-digit PIN". "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # The logo of the gift card program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. @@ -10697,6 +10705,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -11786,6 +11795,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -13250,6 +13260,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -13745,6 +13756,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -14800,6 +14812,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -16200,6 +16213,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -16663,6 +16677,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -17919,6 +17934,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -19563,6 +19579,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -20072,6 +20089,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", diff --git a/docs/dyn/walletobjects_v1.loyaltyclass.html b/docs/dyn/walletobjects_v1.loyaltyclass.html index edef024a70..c6ebf08d9f 100644 --- a/docs/dyn/walletobjects_v1.loyaltyclass.html +++ b/docs/dyn/walletobjects_v1.loyaltyclass.html @@ -1068,6 +1068,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -2245,6 +2246,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -3410,6 +3412,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -4574,6 +4577,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -5754,6 +5758,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -6922,6 +6927,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -8086,6 +8092,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -9252,6 +9259,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -10416,6 +10424,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. diff --git a/docs/dyn/walletobjects_v1.loyaltyobject.html b/docs/dyn/walletobjects_v1.loyaltyobject.html index 85d38dbf58..9da60af218 100644 --- a/docs/dyn/walletobjects_v1.loyaltyobject.html +++ b/docs/dyn/walletobjects_v1.loyaltyobject.html @@ -1378,6 +1378,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -1873,6 +1874,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -3316,6 +3318,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -3811,6 +3814,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -5242,6 +5246,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -5737,6 +5742,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -7167,6 +7173,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -7662,6 +7669,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -9108,6 +9116,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -9603,6 +9612,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -11056,6 +11066,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -11551,6 +11562,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -12983,6 +12995,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -13478,6 +13491,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -14908,6 +14922,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -15403,6 +15418,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -16835,6 +16851,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -17330,6 +17347,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -18760,6 +18778,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "programLogo": { # Wrapping type for Google hosted images. Next ID: 7 # Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -19255,6 +19274,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", diff --git a/docs/dyn/walletobjects_v1.offerclass.html b/docs/dyn/walletobjects_v1.offerclass.html index 54052f0a7e..ad4bcd2367 100644 --- a/docs/dyn/walletobjects_v1.offerclass.html +++ b/docs/dyn/walletobjects_v1.offerclass.html @@ -1007,6 +1007,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -2122,6 +2123,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -3225,6 +3227,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -4327,6 +4330,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -5445,6 +5449,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -6551,6 +6556,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -7653,6 +7659,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -8757,6 +8764,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -9859,6 +9867,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. diff --git a/docs/dyn/walletobjects_v1.offerobject.html b/docs/dyn/walletobjects_v1.offerobject.html index c40951c3ab..b56671bfb1 100644 --- a/docs/dyn/walletobjects_v1.offerobject.html +++ b/docs/dyn/walletobjects_v1.offerobject.html @@ -1312,6 +1312,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -1775,6 +1776,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -3127,6 +3129,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -3590,6 +3593,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -4930,6 +4934,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -5393,6 +5398,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -6732,6 +6738,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -7195,6 +7202,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -8550,6 +8558,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -9013,6 +9022,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -10356,6 +10366,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -10819,6 +10830,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -12158,6 +12170,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -12621,6 +12634,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -13962,6 +13976,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -14425,6 +14440,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -15764,6 +15780,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "provider": "A String", # Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. "redemptionChannel": "A String", # Required. The redemption channels applicable to this offer. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. @@ -16227,6 +16244,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", diff --git a/docs/dyn/walletobjects_v1.transitclass.html b/docs/dyn/walletobjects_v1.transitclass.html index d02efd42d8..2d48353955 100644 --- a/docs/dyn/walletobjects_v1.transitclass.html +++ b/docs/dyn/walletobjects_v1.transitclass.html @@ -1236,6 +1236,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -2592,6 +2593,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -3936,6 +3938,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -5279,6 +5282,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -6638,6 +6642,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -7985,6 +7990,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -9328,6 +9334,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -10673,6 +10680,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -12016,6 +12024,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], diff --git a/docs/dyn/walletobjects_v1.transitobject.html b/docs/dyn/walletobjects_v1.transitobject.html index 123e73cead..3d79035177 100644 --- a/docs/dyn/walletobjects_v1.transitobject.html +++ b/docs/dyn/walletobjects_v1.transitobject.html @@ -1544,6 +1544,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -2053,6 +2054,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -4052,6 +4054,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -4561,6 +4564,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -6548,6 +6552,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -7057,6 +7062,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -9043,6 +9049,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -9552,6 +9559,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -11554,6 +11562,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -12063,6 +12072,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -14053,6 +14063,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -14562,6 +14573,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -16548,6 +16560,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -17057,6 +17070,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -19045,6 +19059,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -19554,6 +19569,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", @@ -21540,6 +21556,7 @@

Method Details

}, ], "multipleDevicesAndHoldersAllowedStatus": "A String", # Identifies whether multiple users and devices will save the same object referencing this class. + "notifyPreference": "A String", # Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "redemptionIssuers": [ # Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap. "A String", ], @@ -22049,6 +22066,7 @@

Method Details

"messageType": "A String", # The message type. }, ], + "notifyPreference": "A String", # Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. "passConstraints": { # Container for any constraints that may be placed on passes. # Pass constraints for the object. Includes limiting NFC and screenshot behaviors. "nfcConstraint": [ # The NFC constraints for the pass. "A String", diff --git a/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.html b/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.html index dbce211409..7281b28375 100644 --- a/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.html +++ b/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.html @@ -174,6 +174,20 @@

Method Details

"a_key": "A String", }, "name": "A String", # The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution} + "notices": [ # Output only. Additional information generated by the execution + { # Message for additional information generated by the execution + "message": "A String", # Output only. Message of the notice + }, + ], + "ruleResults": [ # Output only. execution result summary per rule + { # Message for execution result summary per rule + "message": "A String", # Execution message, if any + "resultCount": "A String", # Number of violations + "rule": "A String", # rule name + "scannedResourceCount": "A String", # Number of total scanned resources + "state": "A String", # Output only. The execution status + }, + ], "runType": "A String", # type represent whether the execution executed directly by user or scheduled according evaluation.schedule field. "startTime": "A String", # Output only. [Output only] Start time stamp "state": "A String", # Output only. [Output only] State @@ -216,6 +230,20 @@

Method Details

"a_key": "A String", }, "name": "A String", # The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution} + "notices": [ # Output only. Additional information generated by the execution + { # Message for additional information generated by the execution + "message": "A String", # Output only. Message of the notice + }, + ], + "ruleResults": [ # Output only. execution result summary per rule + { # Message for execution result summary per rule + "message": "A String", # Execution message, if any + "resultCount": "A String", # Number of violations + "rule": "A String", # rule name + "scannedResourceCount": "A String", # Number of total scanned resources + "state": "A String", # Output only. The execution status + }, + ], "runType": "A String", # type represent whether the execution executed directly by user or scheduled according evaluation.schedule field. "startTime": "A String", # Output only. [Output only] Start time stamp "state": "A String", # Output only. [Output only] State @@ -268,6 +296,20 @@

Method Details

"a_key": "A String", }, "name": "A String", # The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution} + "notices": [ # Output only. Additional information generated by the execution + { # Message for additional information generated by the execution + "message": "A String", # Output only. Message of the notice + }, + ], + "ruleResults": [ # Output only. execution result summary per rule + { # Message for execution result summary per rule + "message": "A String", # Execution message, if any + "resultCount": "A String", # Number of violations + "rule": "A String", # rule name + "scannedResourceCount": "A String", # Number of total scanned resources + "state": "A String", # Output only. The execution status + }, + ], "runType": "A String", # type represent whether the execution executed directly by user or scheduled according evaluation.schedule field. "startTime": "A String", # Output only. [Output only] Start time stamp "state": "A String", # Output only. [Output only] State diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.html index 39b9434e4e..53e24f4ffd 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.html @@ -154,6 +154,9 @@

Method Details

}, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. + "tags": { # Optional. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. } @@ -280,6 +283,9 @@

Method Details

}, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. + "tags": { # Optional. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. }
@@ -346,6 +352,9 @@

Method Details

}, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. + "tags": { # Optional. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. }, @@ -415,6 +424,9 @@

Method Details

}, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. + "tags": { # Optional. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. } diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html index f70a358cd7..0334504f62 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html @@ -196,6 +196,21 @@

Method Details

"type": "A String", # Optional. Type of accelerator resource to attach to the instance, for example, `"nvidia-tesla-p100"`. }, ], + "boostConfigs": [ # Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. + { # A configuration that workstations can boost to. + "accelerators": [ # Optional. A list of the type and count of accelerator cards attached to the boost instance. Defaults to `none`. + { # An accelerator card attached to the instance. + "count": 42, # Optional. Number of accelerator cards exposed to the instance. + "type": "A String", # Optional. Type of accelerator resource to attach to the instance, for example, `"nvidia-tesla-p100"`. + }, + ], + "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. + "id": "A String", # Optional. Required. The id to be used for the boost configuration. + "machineType": "A String", # Optional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`. + "poolSize": 42, # Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`. + }, + ], "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. "confidentialInstanceConfig": { # A set of Compute Engine Confidential VM instance options. # Optional. A set of Compute Engine Confidential VM instance options. "enableConfidentialCompute": True or False, # Optional. Whether the instance has confidential compute enabled. @@ -405,6 +420,21 @@

Method Details

"type": "A String", # Optional. Type of accelerator resource to attach to the instance, for example, `"nvidia-tesla-p100"`. }, ], + "boostConfigs": [ # Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. + { # A configuration that workstations can boost to. + "accelerators": [ # Optional. A list of the type and count of accelerator cards attached to the boost instance. Defaults to `none`. + { # An accelerator card attached to the instance. + "count": 42, # Optional. Number of accelerator cards exposed to the instance. + "type": "A String", # Optional. Type of accelerator resource to attach to the instance, for example, `"nvidia-tesla-p100"`. + }, + ], + "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. + "id": "A String", # Optional. Required. The id to be used for the boost configuration. + "machineType": "A String", # Optional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`. + "poolSize": 42, # Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`. + }, + ], "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. "confidentialInstanceConfig": { # A set of Compute Engine Confidential VM instance options. # Optional. A set of Compute Engine Confidential VM instance options. "enableConfidentialCompute": True or False, # Optional. Whether the instance has confidential compute enabled. @@ -602,6 +632,21 @@

Method Details

"type": "A String", # Optional. Type of accelerator resource to attach to the instance, for example, `"nvidia-tesla-p100"`. }, ], + "boostConfigs": [ # Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. + { # A configuration that workstations can boost to. + "accelerators": [ # Optional. A list of the type and count of accelerator cards attached to the boost instance. Defaults to `none`. + { # An accelerator card attached to the instance. + "count": 42, # Optional. Number of accelerator cards exposed to the instance. + "type": "A String", # Optional. Type of accelerator resource to attach to the instance, for example, `"nvidia-tesla-p100"`. + }, + ], + "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. + "id": "A String", # Optional. Required. The id to be used for the boost configuration. + "machineType": "A String", # Optional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`. + "poolSize": 42, # Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`. + }, + ], "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. "confidentialInstanceConfig": { # A set of Compute Engine Confidential VM instance options. # Optional. A set of Compute Engine Confidential VM instance options. "enableConfidentialCompute": True or False, # Optional. Whether the instance has confidential compute enabled. @@ -753,6 +798,21 @@

Method Details

"type": "A String", # Optional. Type of accelerator resource to attach to the instance, for example, `"nvidia-tesla-p100"`. }, ], + "boostConfigs": [ # Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. + { # A configuration that workstations can boost to. + "accelerators": [ # Optional. A list of the type and count of accelerator cards attached to the boost instance. Defaults to `none`. + { # An accelerator card attached to the instance. + "count": 42, # Optional. Number of accelerator cards exposed to the instance. + "type": "A String", # Optional. Type of accelerator resource to attach to the instance, for example, `"nvidia-tesla-p100"`. + }, + ], + "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. + "id": "A String", # Optional. Required. The id to be used for the boost configuration. + "machineType": "A String", # Optional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`. + "poolSize": 42, # Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`. + }, + ], "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. "confidentialInstanceConfig": { # A set of Compute Engine Confidential VM instance options. # Optional. A set of Compute Engine Confidential VM instance options. "enableConfidentialCompute": True or False, # Optional. Whether the instance has confidential compute enabled. @@ -919,6 +979,21 @@

Method Details

"type": "A String", # Optional. Type of accelerator resource to attach to the instance, for example, `"nvidia-tesla-p100"`. }, ], + "boostConfigs": [ # Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. + { # A configuration that workstations can boost to. + "accelerators": [ # Optional. A list of the type and count of accelerator cards attached to the boost instance. Defaults to `none`. + { # An accelerator card attached to the instance. + "count": 42, # Optional. Number of accelerator cards exposed to the instance. + "type": "A String", # Optional. Type of accelerator resource to attach to the instance, for example, `"nvidia-tesla-p100"`. + }, + ], + "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. + "id": "A String", # Optional. Required. The id to be used for the boost configuration. + "machineType": "A String", # Optional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`. + "poolSize": 42, # Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`. + }, + ], "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. "confidentialInstanceConfig": { # A set of Compute Engine Confidential VM instance options. # Optional. A set of Compute Engine Confidential VM instance options. "enableConfidentialCompute": True or False, # Optional. Whether the instance has confidential compute enabled. diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html index aaecfbe443..2edbd19fe3 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html @@ -156,6 +156,9 @@

Method Details

"satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. + "tags": { # Optional. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. } @@ -284,6 +287,9 @@

Method Details

"satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. + "tags": { # Optional. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. }
@@ -352,6 +358,9 @@

Method Details

"satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. + "tags": { # Optional. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. }, @@ -423,6 +432,9 @@

Method Details

"satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. + "tags": { # Optional. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. } diff --git a/docs/dyn/youtube_v3.tests.html b/docs/dyn/youtube_v3.tests.html index 837b7cdb58..f98130a3c9 100644 --- a/docs/dyn/youtube_v3.tests.html +++ b/docs/dyn/youtube_v3.tests.html @@ -96,6 +96,7 @@

Method Details

The object takes the form of: { + "etag": "A String", # Etag for the resource. See https://en.wikipedia.org/wiki/HTTP_ETag. "featuredPart": True or False, "gaia": "A String", "id": "A String", @@ -113,6 +114,7 @@

Method Details

An object of the form: { + "etag": "A String", # Etag for the resource. See https://en.wikipedia.org/wiki/HTTP_ETag. "featuredPart": True or False, "gaia": "A String", "id": "A String", diff --git a/docs/dyn/youtube_v3.watermarks.html b/docs/dyn/youtube_v3.watermarks.html index 2c053dd83e..d6a3b106fe 100644 --- a/docs/dyn/youtube_v3.watermarks.html +++ b/docs/dyn/youtube_v3.watermarks.html @@ -98,7 +98,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # LINT.IfChange Describes an invideo branding. +{ # Describes an invideo branding. "imageBytes": "A String", # The bytes the uploaded image. Only used in api to youtube communication. "imageUrl": "A String", # The url of the uploaded image. Only used in apiary to api communication. "position": { # Describes the spatial position of a visual widget inside a video. It is a union of various position types, out of which only will be set one. # The spatial position within the video where the branding watermark will be displayed. diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json index 7be6bab6fa..ed851ef84d 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json @@ -1205,8 +1205,8 @@ "name" ], "parameters": { -"appendScopedAccessSettings": { -"description": "Optional. This field will be used to control whether or not scoped access settings are appended to the existing list of scoped access settings. If true, the scoped access settings in the request will be appended to the existing list of scoped access settings. If false, the scoped access settings in the request replace the existing list of scoped access settings.", +"append": { +"description": "Optional. This field controls whether or not certain repeated settings in the update request overwrite or append to existing settings on the binding. If true, then append. Otherwise overwrite. So far, only scoped_access_settings supports appending. Global access_levels, dry_run_access_levels, reauth_settings, and session_settings are not compatible with append functionality, and the request will return an error if append=true when these settings are in the update_mask. The request will also return an error if append=true when \"scoped_access_settings\" is not set in the update_mask.", "location": "query", "type": "boolean" }, @@ -1218,7 +1218,7 @@ "type": "string" }, "updateMask": { -"description": "Required. Only the fields specified in this mask are updated. Because name and group_key cannot be changed, update_mask is required and may only contain the following fields: `access_levels`, `dry_run_access_levels`, `reauth_settings`, `scoped_access_settings`. update_mask { paths: \"access_levels\" }", +"description": "Required. Only the fields specified in this mask are updated. Because name and group_key cannot be changed, update_mask is required and may only contain the following fields: `access_levels`, `dry_run_access_levels`, `reauth_settings` `session_settings`, `scoped_access_settings`. update_mask { paths: \"access_levels\" }", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1295,7 +1295,7 @@ } } }, -"revision": "20240923", +"revision": "20241022", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -1387,6 +1387,10 @@ "reauthSettings": { "$ref": "ReauthSettings", "description": "Optional. Reauth settings applied to user access on a given AccessScope." +}, +"sessionSettings": { +"$ref": "SessionSettings", +"description": "Optional. Session settings applied to user access on a given AccessScope. Migrated from ReauthSettings" } }, "type": "object" @@ -1880,7 +1884,7 @@ "type": "object" }, "GcpUserAccessBinding": { -"description": "Restricts access to Cloud Console and Google Cloud APIs for a set of users using Context-Aware Access.", +"description": "Restricts access to Cloud Console and Google Cloud APIs for a set of users using Context-Aware Access. Next ID: 11", "id": "GcpUserAccessBinding", "properties": { "accessLevels": { @@ -2500,6 +2504,47 @@ }, "type": "object" }, +"SessionSettings": { +"description": "Stores settings related to Google Cloud Session Length including session duration, the type of challenge (i.e. method) they should face when their session expires, and other related settings.", +"id": "SessionSettings", +"properties": { +"maxInactivity": { +"description": "Optional. How long a user is allowed to take between actions before a new access token must be issued. Presently only set for Cloud Apps.", +"format": "google-duration", +"type": "string" +}, +"sessionLength": { +"description": "Optional. The session length. Setting this field to zero is equal to disabling. Session. Also can set infinite session by flipping the enabled bit to false below. If use_oidc_max_age is true, for OIDC apps, the session length will be the minimum of this field and OIDC max_age param.", +"format": "google-duration", +"type": "string" +}, +"sessionLengthEnabled": { +"description": "Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite.", +"type": "boolean" +}, +"sessionReauthMethod": { +"description": "Optional. Session method when users GCP session is up.", +"enum": [ +"SESSION_REAUTH_METHOD_UNSPECIFIED", +"LOGIN", +"SECURITY_KEY", +"PASSWORD" +], +"enumDescriptions": [ +"If method undefined in API, we will use LOGIN by default.", +"The user will prompted to perform regular login. Users who are enrolled for two-step verification and haven't chosen to \"Remember this computer\" will be prompted for their second factor.", +"The user will be prompted to autheticate using their security key. If no security key has been configured, then we will fallback to LOGIN.", +"The user will be prompted for their password." +], +"type": "string" +}, +"useOidcMaxAge": { +"description": "Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param.", +"type": "boolean" +} +}, +"type": "object" +}, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index 654b3a4bb5..7d54370fa4 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -4466,6 +4466,34 @@ "resources": { "features": { "methods": { +"batchCreate": { +"description": "Creates a batch of Features in a given FeatureGroup.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.featureGroups.features.batchCreate", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/features:batchCreate", +"request": { +"$ref": "GoogleCloudAiplatformV1BatchCreateFeaturesRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "create": { "description": "Creates a new Feature in a given FeatureGroup.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", @@ -17846,7 +17874,7 @@ } } }, -"revision": "20241001", +"revision": "20241007", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -17897,6 +17925,10 @@ "$ref": "CloudAiLargeModelsVisionImageRAIScores", "description": "RAI scores for generated image." }, +"imageSize": { +"$ref": "CloudAiLargeModelsVisionImageImageSize", +"description": "Image size. The size of the image. Can be self reported, or computed from the image bytes." +}, "raiInfo": { "$ref": "CloudAiLargeModelsVisionRaiInfo", "description": "RAI info for image." @@ -17916,6 +17948,25 @@ }, "type": "object" }, +"CloudAiLargeModelsVisionImageImageSize": { +"description": "Image size.", +"id": "CloudAiLargeModelsVisionImageImageSize", +"properties": { +"channels": { +"format": "int32", +"type": "integer" +}, +"height": { +"format": "int32", +"type": "integer" +}, +"width": { +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "CloudAiLargeModelsVisionImageRAIScores": { "description": "RAI scores for generated image returned.", "id": "CloudAiLargeModelsVisionImageRAIScores", @@ -20496,6 +20547,10 @@ "description": "The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations", "type": "string" }, +"pscInterfaceConfig": { +"$ref": "GoogleCloudAiplatformV1PscInterfaceConfig", +"description": "Optional. Configuration for PSC-I for CustomJob." +}, "reservedIpRanges": { "description": "Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].", "items": { @@ -23839,6 +23894,10 @@ "description": "Configuration for Sync. Only one option is set.", "id": "GoogleCloudAiplatformV1FeatureViewSyncConfig", "properties": { +"continuous": { +"description": "Optional. If true, syncs the FeatureView in a continuous manner to Online Store.", +"type": "boolean" +}, "cron": { "description": "Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or \"TZ=${IANA_TIME_ZONE}\". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, \"CRON_TZ=America/New_York 1 * * * *\", or \"TZ=America/New_York 1 * * * *\".", "type": "string" @@ -24732,6 +24791,10 @@ "description": "Generation config.", "id": "GoogleCloudAiplatformV1GenerationConfig", "properties": { +"audioTimestamp": { +"description": "Optional. If enabled, audio timestamp will be included in the request to the model.", +"type": "boolean" +}, "candidateCount": { "description": "Optional. Number of candidates to generate.", "format": "int32", @@ -30943,6 +31006,12 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1PscInterfaceConfig": { +"description": "Configuration for PSC-I.", +"id": "GoogleCloudAiplatformV1PscInterfaceConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudAiplatformV1PublisherModel": { "description": "A Model Garden Publisher Model.", "id": "GoogleCloudAiplatformV1PublisherModel", @@ -32988,7 +33057,7 @@ false "type": "string" }, "enum": { -"description": "Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:[\"EAST\", NORTH\", \"SOUTH\", \"WEST\"]}", +"description": "Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[\"EAST\", NORTH\", \"SOUTH\", \"WEST\"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[\"101\", \"201\", \"301\"]}", "items": { "type": "string" }, @@ -34898,6 +34967,162 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1SchemaPromptApiSchema": { +"description": "The A2 schema of a prompt.", +"id": "GoogleCloudAiplatformV1SchemaPromptApiSchema", +"properties": { +"apiSchemaVersion": { +"description": "The Schema version that represents changes to the API behavior.", +"type": "string" +}, +"executions": { +"description": "A list of execution instances for constructing a ready-to-use prompt.", +"items": { +"$ref": "GoogleCloudAiplatformV1SchemaPromptInstancePromptExecution" +}, +"type": "array" +}, +"multimodalPrompt": { +"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt", +"description": "Multimodal prompt which embeds preambles to prompt string." +}, +"structuredPrompt": { +"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt", +"description": "The prompt variation that stores preambles in separate fields." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1SchemaPromptInstancePromptExecution": { +"description": "A prompt instance's parameters set that contains a set of variable values.", +"id": "GoogleCloudAiplatformV1SchemaPromptInstancePromptExecution", +"properties": { +"arguments": { +"additionalProperties": { +"$ref": "GoogleCloudAiplatformV1SchemaPromptInstanceVariableValue" +}, +"description": "Maps variable names to their value.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1SchemaPromptInstanceVariableValue": { +"description": "The value of a variable in prompt.", +"id": "GoogleCloudAiplatformV1SchemaPromptInstanceVariableValue", +"properties": { +"partList": { +"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPartList", +"description": "The parts of the variable value." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt": { +"description": "Prompt variation that embeds preambles to prompt string.", +"id": "GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt", +"properties": { +"promptMessage": { +"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage", +"description": "The prompt message." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1SchemaPromptSpecPartList": { +"description": "A list of elements and information that make up a portion of prompt.", +"id": "GoogleCloudAiplatformV1SchemaPromptSpecPartList", +"properties": { +"parts": { +"description": "A list of elements that can be part of a prompt.", +"items": { +"$ref": "GoogleCloudAiplatformV1Part" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage": { +"description": "The prompt message that aligns with the prompt message in google.cloud.aiplatform.master.GenerateContentRequest.", +"id": "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage", +"properties": { +"contents": { +"description": "The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.", +"items": { +"$ref": "GoogleCloudAiplatformV1Content" +}, +"type": "array" +}, +"generationConfig": { +"$ref": "GoogleCloudAiplatformV1GenerationConfig", +"description": "Generation config." +}, +"model": { +"description": "The model name.", +"type": "string" +}, +"safetySettings": { +"description": "Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.", +"items": { +"$ref": "GoogleCloudAiplatformV1SafetySetting" +}, +"type": "array" +}, +"systemInstruction": { +"$ref": "GoogleCloudAiplatformV1Content", +"description": "The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph." +}, +"toolConfig": { +"$ref": "GoogleCloudAiplatformV1ToolConfig", +"description": "Tool config. This config is shared for all tools provided in the request." +}, +"tools": { +"description": "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.", +"items": { +"$ref": "GoogleCloudAiplatformV1Tool" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt": { +"description": "Prompt variation that stores preambles in separate fields.", +"id": "GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt", +"properties": { +"context": { +"$ref": "GoogleCloudAiplatformV1Content", +"description": "Preamble: The context of the prompt." +}, +"examples": { +"description": "Preamble: A set of examples for expected model response.", +"items": { +"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPartList" +}, +"type": "array" +}, +"inputPrefixes": { +"description": "Preamble: The input prefixes before each example input.", +"items": { +"type": "string" +}, +"type": "array" +}, +"outputPrefixes": { +"description": "Preamble: The output prefixes before each example output.", +"items": { +"type": "string" +}, +"type": "array" +}, +"promptMessage": { +"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage", +"description": "The prompt message." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1SchemaTablesDatasetMetadata": { "description": "The metadata of Datasets that contain tables data.", "id": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadata", @@ -35039,6 +35264,10 @@ false "description": "User-created prompt note. Note size limit is 2KB.", "type": "string" }, +"promptApiSchema": { +"$ref": "GoogleCloudAiplatformV1SchemaPromptApiSchema", +"description": "The API schema of the prompt to support both UI and SDK usages." +}, "promptType": { "description": "Type of the prompt dataset.", "type": "string" @@ -39220,7 +39449,7 @@ false "id": "GoogleCloudAiplatformV1ToolParameterKVMatchSpec", "properties": { "useStrictStringMatch": { -"description": "Optional. Whether to use STRCIT string match on parameter values.", +"description": "Optional. Whether to use STRICT string match on parameter values.", "type": "boolean" } }, diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 0c27419e34..0519e6dee8 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -6165,6 +6165,34 @@ "resources": { "features": { "methods": { +"batchCreate": { +"description": "Creates a batch of Features in a given FeatureGroup.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.featureGroups.features.batchCreate", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/features:batchCreate", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "create": { "description": "Creates a new Feature in a given FeatureGroup.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", @@ -21202,7 +21230,7 @@ } } }, -"revision": "20241001", +"revision": "20241007", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -21253,6 +21281,10 @@ "$ref": "CloudAiLargeModelsVisionImageRAIScores", "description": "RAI scores for generated image." }, +"imageSize": { +"$ref": "CloudAiLargeModelsVisionImageImageSize", +"description": "Image size. The size of the image. Can be self reported, or computed from the image bytes." +}, "raiInfo": { "$ref": "CloudAiLargeModelsVisionRaiInfo", "description": "RAI info for image." @@ -21272,6 +21304,25 @@ }, "type": "object" }, +"CloudAiLargeModelsVisionImageImageSize": { +"description": "Image size.", +"id": "CloudAiLargeModelsVisionImageImageSize", +"properties": { +"channels": { +"format": "int32", +"type": "integer" +}, +"height": { +"format": "int32", +"type": "integer" +}, +"width": { +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "CloudAiLargeModelsVisionImageRAIScores": { "description": "RAI scores for generated image returned.", "id": "CloudAiLargeModelsVisionImageRAIScores", @@ -24415,6 +24466,10 @@ "description": "The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations", "type": "string" }, +"pscInterfaceConfig": { +"$ref": "GoogleCloudAiplatformV1beta1PscInterfaceConfig", +"description": "Optional. Configuration for PSC-I for CustomJob." +}, "reservedIpRanges": { "description": "Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].", "items": { @@ -28238,6 +28293,10 @@ "description": "Configuration for Sync. Only one option is set.", "id": "GoogleCloudAiplatformV1beta1FeatureViewSyncConfig", "properties": { +"continuous": { +"description": "Optional. If true, syncs the FeatureView in a continuous manner to Online Store.", +"type": "boolean" +}, "cron": { "description": "Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or \"TZ=${IANA_TIME_ZONE}\". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, \"CRON_TZ=America/New_York 1 * * * *\", or \"TZ=America/New_York 1 * * * *\".", "type": "string" @@ -29323,6 +29382,10 @@ "description": "Generation config.", "id": "GoogleCloudAiplatformV1beta1GenerationConfig", "properties": { +"audioTimestamp": { +"description": "Optional. If enabled, audio timestamp will be included in the request to the model.", +"type": "boolean" +}, "candidateCount": { "description": "Optional. Number of candidates to generate.", "format": "int32", @@ -35980,6 +36043,10 @@ false "description": "Optional. Whether to do component level validations before job creation.", "type": "boolean" }, +"pscInterfaceConfig": { +"$ref": "GoogleCloudAiplatformV1beta1PscInterfaceConfig", +"description": "Optional. Configuration for PSC-I for PipelineJob." +}, "reservedIpRanges": { "description": "A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].", "items": { @@ -39681,7 +39748,7 @@ false "type": "string" }, "enum": { -"description": "Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:[\"EAST\", NORTH\", \"SOUTH\", \"WEST\"]}", +"description": "Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[\"EAST\", NORTH\", \"SOUTH\", \"WEST\"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[\"101\", \"201\", \"301\"]}", "items": { "type": "string" }, @@ -40920,6 +40987,70 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1SchemaPredictParamsGroundingConfig": { +"description": "The configuration for grounding checking.", +"id": "GoogleCloudAiplatformV1beta1SchemaPredictParamsGroundingConfig", +"properties": { +"disableAttribution": { +"deprecated": true, +"description": "If set, skip finding claim attributions (i.e not generate grounding citation).", +"type": "boolean" +}, +"sources": { +"description": "The sources for the grounding checking.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1SchemaPredictParamsGroundingConfigSourceEntry" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SchemaPredictParamsGroundingConfigSourceEntry": { +"description": "Single source entry for the grounding checking.", +"id": "GoogleCloudAiplatformV1beta1SchemaPredictParamsGroundingConfigSourceEntry", +"properties": { +"enterpriseDatastore": { +"deprecated": true, +"description": "The uri of the Vertex AI Search data source. Deprecated. Use vertex_ai_search_datastore instead.", +"type": "string" +}, +"inlineContext": { +"description": "The grounding text passed inline with the Predict API. It can support up to 1 million bytes.", +"type": "string" +}, +"type": { +"description": "The type of the grounding checking source.", +"enum": [ +"UNSPECIFIED", +"WEB", +"ENTERPRISE", +"VERTEX_AI_SEARCH", +"INLINE" +], +"enumDeprecated": [ +false, +false, +true, +false, +false +], +"enumDescriptions": [ +"", +"Uses Web Search to check the grounding.", +"Uses Vertex AI Search to check the grounding. Deprecated. Use VERTEX_AI_SEARCH instead.", +"Uses Vertex AI Search to check the grounding", +"Uses inline context to check the grounding." +], +"type": "string" +}, +"vertexAiSearchDatastore": { +"description": "The uri of the Vertex AI Search data source.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1SchemaPredictParamsImageClassificationPredictionParams": { "description": "Prediction model parameters for Image Classification.", "id": "GoogleCloudAiplatformV1beta1SchemaPredictParamsImageClassificationPredictionParams", @@ -41527,6 +41658,162 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1SchemaPromptApiSchema": { +"description": "The A2 schema of a prompt.", +"id": "GoogleCloudAiplatformV1beta1SchemaPromptApiSchema", +"properties": { +"apiSchemaVersion": { +"description": "The Schema version that represents changes to the API behavior.", +"type": "string" +}, +"executions": { +"description": "A list of execution instances for constructing a ready-to-use prompt.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1SchemaPromptInstancePromptExecution" +}, +"type": "array" +}, +"multimodalPrompt": { +"$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecMultimodalPrompt", +"description": "Multimodal prompt which embeds preambles to prompt string." +}, +"structuredPrompt": { +"$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecStructuredPrompt", +"description": "The prompt variation that stores preambles in separate fields." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SchemaPromptInstancePromptExecution": { +"description": "A prompt instance's parameters set that contains a set of variable values.", +"id": "GoogleCloudAiplatformV1beta1SchemaPromptInstancePromptExecution", +"properties": { +"arguments": { +"additionalProperties": { +"$ref": "GoogleCloudAiplatformV1beta1SchemaPromptInstanceVariableValue" +}, +"description": "Maps variable names to their value.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SchemaPromptInstanceVariableValue": { +"description": "The value of a variable in prompt.", +"id": "GoogleCloudAiplatformV1beta1SchemaPromptInstanceVariableValue", +"properties": { +"partList": { +"$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecPartList", +"description": "The parts of the variable value." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SchemaPromptSpecMultimodalPrompt": { +"description": "Prompt variation that embeds preambles to prompt string.", +"id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecMultimodalPrompt", +"properties": { +"promptMessage": { +"$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecPromptMessage", +"description": "The prompt message." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SchemaPromptSpecPartList": { +"description": "A list of elements and information that make up a portion of prompt.", +"id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecPartList", +"properties": { +"parts": { +"description": "A list of elements that can be part of a prompt.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1Part" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SchemaPromptSpecPromptMessage": { +"description": "The prompt message that aligns with the prompt message in google.cloud.aiplatform.master.GenerateContentRequest.", +"id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecPromptMessage", +"properties": { +"contents": { +"description": "The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1Content" +}, +"type": "array" +}, +"generationConfig": { +"$ref": "GoogleCloudAiplatformV1beta1GenerationConfig", +"description": "Generation config." +}, +"model": { +"description": "The model name.", +"type": "string" +}, +"safetySettings": { +"description": "Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1SafetySetting" +}, +"type": "array" +}, +"systemInstruction": { +"$ref": "GoogleCloudAiplatformV1beta1Content", +"description": "The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph." +}, +"toolConfig": { +"$ref": "GoogleCloudAiplatformV1beta1ToolConfig", +"description": "Tool config. This config is shared for all tools provided in the request." +}, +"tools": { +"description": "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.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1Tool" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SchemaPromptSpecStructuredPrompt": { +"description": "Prompt variation that stores preambles in separate fields.", +"id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecStructuredPrompt", +"properties": { +"context": { +"$ref": "GoogleCloudAiplatformV1beta1Content", +"description": "Preamble: The context of the prompt." +}, +"examples": { +"description": "Preamble: A set of examples for expected model response.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecPartList" +}, +"type": "array" +}, +"inputPrefixes": { +"description": "Preamble: The input prefixes before each example input.", +"items": { +"type": "string" +}, +"type": "array" +}, +"outputPrefixes": { +"description": "Preamble: The output prefixes before each example output.", +"items": { +"type": "string" +}, +"type": "array" +}, +"promptMessage": { +"$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecPromptMessage", +"description": "The prompt message." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadata": { "description": "The metadata of Datasets that contain tables data.", "id": "GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadata", @@ -41634,6 +41921,94 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1SchemaTextPromptDatasetMetadata": { +"description": "The metadata of Datasets that contain Text Prompt data.", +"id": "GoogleCloudAiplatformV1beta1SchemaTextPromptDatasetMetadata", +"properties": { +"candidateCount": { +"description": "Number of candidates.", +"format": "int64", +"type": "string" +}, +"gcsUri": { +"description": "The Google Cloud Storage URI that stores the prompt data.", +"type": "string" +}, +"groundingConfig": { +"$ref": "GoogleCloudAiplatformV1beta1SchemaPredictParamsGroundingConfig", +"description": "Grounding checking configuration." +}, +"hasPromptVariable": { +"description": "Whether the prompt dataset has prompt variable.", +"type": "boolean" +}, +"logprobs": { +"description": "Whether or not the user has enabled logit probabilities in the model parameters.", +"type": "boolean" +}, +"maxOutputTokens": { +"description": "Value of the maximum number of tokens generated set when the dataset was saved.", +"format": "int64", +"type": "string" +}, +"note": { +"description": "User-created prompt note. Note size limit is 2KB.", +"type": "string" +}, +"promptApiSchema": { +"$ref": "GoogleCloudAiplatformV1beta1SchemaPromptApiSchema", +"description": "The API schema of the prompt to support both UI and SDK usages." +}, +"promptType": { +"description": "Type of the prompt dataset.", +"type": "string" +}, +"seedEnabled": { +"description": "Seeding enables model to return a deterministic response on a best effort basis. Determinism isn't guaranteed. This field determines whether or not seeding is enabled.", +"type": "boolean" +}, +"seedValue": { +"description": "The actual value of the seed.", +"format": "int64", +"type": "string" +}, +"stopSequences": { +"description": "Customized stop sequences.", +"items": { +"type": "string" +}, +"type": "array" +}, +"systemInstruction": { +"description": "The content of the prompt dataset system instruction.", +"type": "string" +}, +"systemInstructionGcsUri": { +"description": "The Google Cloud Storage URI that stores the system instruction, starting with gs://.", +"type": "string" +}, +"temperature": { +"description": "Temperature value used for sampling set when the dataset was saved. This value is used to tune the degree of randomness.", +"format": "float", +"type": "number" +}, +"text": { +"description": "The content of the prompt dataset.", +"type": "string" +}, +"topK": { +"description": "Top K value set when the dataset was saved. This value determines how many candidates with highest probability from the vocab would be selected for each decoding step.", +"format": "int64", +"type": "string" +}, +"topP": { +"description": "Top P value set when the dataset was saved. Given topK tokens for decoding, top candidates will be selected until the sum of their probabilities is topP.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1SchemaTextSegment": { "description": "The text segment inside of DataItem.", "id": "GoogleCloudAiplatformV1beta1SchemaTextSegment", @@ -46120,7 +46495,7 @@ false "id": "GoogleCloudAiplatformV1beta1ToolParameterKVMatchSpec", "properties": { "useStrictStringMatch": { -"description": "Optional. Whether to use STRCIT string match on parameter values.", +"description": "Optional. Whether to use STRICT string match on parameter values.", "type": "boolean" } }, diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json index 5eddae51fa..42cc35d687 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json @@ -1517,7 +1517,7 @@ } } }, -"revision": "20241002", +"revision": "20241015", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -4635,6 +4635,7 @@ false "type": "integer" }, "retentionUnit": { +"deprecated": true, "description": "The unit that 'retained_backups' represents.", "enum": [ "RETENTION_UNIT_UNSPECIFIED", @@ -4655,6 +4656,11 @@ false "timeBasedRetention": { "format": "google-duration", "type": "string" +}, +"timestampBasedRetentionTime": { +"description": "Timestamp based retention period i.e. 2024-05-01T00:00:00Z", +"format": "google-datetime", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json index e89b746782..c06a1121c6 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json @@ -1517,7 +1517,7 @@ } } }, -"revision": "20241002", +"revision": "20241015", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -4799,6 +4799,7 @@ false "type": "integer" }, "retentionUnit": { +"deprecated": true, "description": "The unit that 'retained_backups' represents.", "enum": [ "RETENTION_UNIT_UNSPECIFIED", @@ -4819,6 +4820,11 @@ false "timeBasedRetention": { "format": "google-duration", "type": "string" +}, +"timestampBasedRetentionTime": { +"description": "Timestamp based retention period i.e. 2024-05-01T00:00:00Z", +"format": "google-datetime", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json index 041546f858..86031531f8 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json @@ -1514,7 +1514,7 @@ } } }, -"revision": "20241002", +"revision": "20241015", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -4751,6 +4751,7 @@ false "type": "integer" }, "retentionUnit": { +"deprecated": true, "description": "The unit that 'retained_backups' represents.", "enum": [ "RETENTION_UNIT_UNSPECIFIED", @@ -4771,6 +4772,11 @@ false "timeBasedRetention": { "format": "google-duration", "type": "string" +}, +"timestampBasedRetentionTime": { +"description": "Timestamp based retention period i.e. 2024-05-01T00:00:00Z", +"format": "google-datetime", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json index e12299e988..196e6d8d2a 100644 --- a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json @@ -2654,7 +2654,7 @@ } } }, -"revision": "20240820", +"revision": "20241021", "rootUrl": "https://androidenterprise.googleapis.com/", "schemas": { "Administrator": { @@ -4050,6 +4050,10 @@ "$ref": "MaintenanceWindow", "description": "The maintenance window defining when apps running in the foreground should be updated." }, +"policyId": { +"description": "An identifier for the policy that will be passed with the app install feedback sent from the Play Store.", +"type": "string" +}, "productAvailabilityPolicy": { "description": "The availability granted to the device for the specified products. \"all\" gives the device access to all products, regardless of approval status. \"all\" does not enable automatic visibility of \"alpha\" or \"beta\" tracks. \"whitelist\" grants the device access the products specified in productPolicy[]. Only products that are approved or products that were previously approved (products with revoked approval) by the enterprise can be whitelisted. If no value is provided, the availability set at the user level is applied by default.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index c465e580b5..43e6d9a6e4 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1168,7 +1168,7 @@ } } }, -"revision": "20240924", +"revision": "20241022", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -3087,7 +3087,7 @@ "Personal usage restriction is not specified", "Personal usage is allowed", "Personal usage is disallowed", -"Device is not associated with a single user, and thus both personal usage and corporate identity authentication are not expected." +"Device is not associated with a single user, and thus both personal usage and corporate identity authentication are not expected. Important: This setting is mandatory for dedicated device enrollment and it is a breaking change. This change needs to be implemented before January 2025.For additional details see the dedicated device provisioning guide (https://developers.google.com/android/management/provision-device#company-owned_devices_for_work_use_only). " ], "type": "string" }, @@ -5800,7 +5800,7 @@ false "Personal usage restriction is not specified", "Personal usage is allowed", "Personal usage is disallowed", -"Device is not associated with a single user, and thus both personal usage and corporate identity authentication are not expected." +"Device is not associated with a single user, and thus both personal usage and corporate identity authentication are not expected. Important: This setting is mandatory for dedicated device enrollment and it is a breaking change. This change needs to be implemented before January 2025.For additional details see the dedicated device provisioning guide (https://developers.google.com/android/management/provision-device#company-owned_devices_for_work_use_only). " ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index 4b699ada77..48a28c716c 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -4732,7 +4732,7 @@ } } }, -"revision": "20241003", +"revision": "20241016", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -6086,6 +6086,13 @@ "$ref": "SystemFeature" }, "type": "array" +}, +"systemOnChips": { +"description": "Optional. The SoCs included by this selector. Only works for Android S+ devices.", +"items": { +"$ref": "SystemOnChip" +}, +"type": "array" } }, "type": "object" @@ -9131,6 +9138,21 @@ false "properties": {}, "type": "object" }, +"SystemOnChip": { +"description": "Representation of a System-on-Chip (SoC) of an Android device. Can be used to target S+ devices.", +"id": "SystemOnChip", +"properties": { +"manufacturer": { +"description": "Required. The designer of the SoC, eg. \"Google\" Value of build property \"ro.soc.manufacturer\" https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER Required.", +"type": "string" +}, +"model": { +"description": "Required. The model of the SoC, eg. \"Tensor\" Value of build property \"ro.soc.model\" https://developer.android.com/reference/android/os/Build#SOC_MODEL Required.", +"type": "string" +} +}, +"type": "object" +}, "Targeting": { "description": "Targeting details for a recovery action such as regions, android sdk levels, app versions etc.", "id": "Targeting", diff --git a/googleapiclient/discovery_cache/documents/apigee.v1.json b/googleapiclient/discovery_cache/documents/apigee.v1.json index 7da2b10c9a..483f1d4e35 100644 --- a/googleapiclient/discovery_cache/documents/apigee.v1.json +++ b/googleapiclient/discovery_cache/documents/apigee.v1.json @@ -15,6 +15,18 @@ "description": "Use the Apigee API to programmatically develop and manage APIs with a set of RESTful operations. Develop and secure API proxies, deploy and undeploy API proxy revisions, monitor APIs, configure environments, manage users, and more. Note: This product is available as a free trial for a time period of 60 days.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/apigee-api-management/", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://apigee.us.rep.googleapis.com/", +"location": "us" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://apigee.eu.rep.googleapis.com/", +"location": "eu" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -9574,7 +9586,7 @@ ], "parameters": { "parent": { -"description": "Required. The parent resource name.", +"description": "Required. The parent resource name. Format: `organizations/{org}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -9607,7 +9619,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the security profile v2 to delete.", +"description": "Required. The name of the security profile v2 to delete. Format: `organizations/{org}/securityProfilesV2/{profile}`", "location": "path", "pattern": "^organizations/[^/]+/securityProfilesV2/[^/]+$", "required": true, @@ -9632,7 +9644,7 @@ ], "parameters": { "name": { -"description": "Required. The security profile id.", +"description": "Required. The name of the security profile v2 to get. Format: `organizations/{org}/securityProfilesV2/{profile}`", "location": "path", "pattern": "^organizations/[^/]+/securityProfilesV2/[^/]+$", "required": true, @@ -9700,7 +9712,7 @@ "type": "string" }, "updateMask": { -"description": "Required. The list of fields to update.", +"description": "Optional. The list of fields to update. Valid fields to update are `description` and `profileAssessmentConfigs`.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -10373,7 +10385,7 @@ } } }, -"revision": "20241004", +"revision": "20241017", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { diff --git a/googleapiclient/discovery_cache/documents/apikeys.v2.json b/googleapiclient/discovery_cache/documents/apikeys.v2.json index 6069b0de8b..55930eaf06 100644 --- a/googleapiclient/discovery_cache/documents/apikeys.v2.json +++ b/googleapiclient/discovery_cache/documents/apikeys.v2.json @@ -396,7 +396,7 @@ } } }, -"revision": "20240811", +"revision": "20241016", "rootUrl": "https://apikeys.googleapis.com/", "schemas": { "Operation": { @@ -593,6 +593,10 @@ "$ref": "V2Restrictions", "description": "Key restrictions." }, +"serviceAccountEmail": { +"description": "Optional. The email address of [the service account](https://cloud.google.com/iam/docs/service-accounts) the key is bound to.", +"type": "string" +}, "uid": { "description": "Output only. Unique id in UUID4 format.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json index a64e1f9252..191ac81a62 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json @@ -2334,7 +2334,7 @@ ], "parameters": { "name": { -"description": "The name of the rule, for example: \"projects/p1/locations/us-central1/repositories/repo1/rules/rule1\".", +"description": "The name of the rule, for example: `projects/p1/locations/us-central1/repositories/repo1/rules/rule1`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/rules/[^/]+$", "required": true, @@ -2439,7 +2439,7 @@ } } }, -"revision": "20241010", +"revision": "20241011", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -3101,11 +3101,11 @@ "type": "object" }, "GoogleDevtoolsArtifactregistryV1Rule": { -"description": "A Rule applies to repository or package level. It defines the deny or allow action of the operation when the conditions in the rule are met.", +"description": "A rule defines the deny or allow action of the operation it applies to and the conditions required for the rule to apply. You can set one rule for an entire repository and one rule for each package within.", "id": "GoogleDevtoolsArtifactregistryV1Rule", "properties": { "action": { -"description": "The action this rule makes.", +"description": "The action this rule takes.", "enum": [ "ACTION_UNSPECIFIED", "ALLOW", @@ -3120,10 +3120,10 @@ }, "condition": { "$ref": "Expr", -"description": "Optional. The condition of the rule in CEL expression. If not provided, the rule matches all the objects." +"description": "Optional. A CEL expression for conditions that must be met in order for the rule to apply. If not provided, the rule matches all objects." }, "name": { -"description": "The name of the rule, for example: \"projects/p1/locations/us-central1/repositories/repo1/rules/rule1\".", +"description": "The name of the rule, for example: `projects/p1/locations/us-central1/repositories/repo1/rules/rule1`.", "type": "string" }, "operation": { @@ -3138,7 +3138,7 @@ "type": "string" }, "packageId": { -"description": "The package ID the rule applies to. If empty, this rule applies to all the packages inside the repository.", +"description": "The package ID the rule applies to. If empty, this rule applies to all packages inside the repository.", "type": "string" } }, @@ -4174,6 +4174,10 @@ false "virtualRepositoryConfig": { "$ref": "VirtualRepositoryConfig", "description": "Configuration specific for a Virtual Repository." +}, +"vulnerabilityScanningConfig": { +"$ref": "VulnerabilityScanningConfig", +"description": "Optional. Config and state for vulnerability scanning of resources within this Repository." } }, "type": "object" @@ -4619,6 +4623,55 @@ false }, "type": "object" }, +"VulnerabilityScanningConfig": { +"description": "Config on whether to perform vulnerability scanning for resources in this repository, as well as output fields describing current state.", +"id": "VulnerabilityScanningConfig", +"properties": { +"enablementConfig": { +"description": "Optional. Config for whether this repository has vulnerability scanning disabled.", +"enum": [ +"ENABLEMENT_CONFIG_UNSPECIFIED", +"INHERITED", +"DISABLED" +], +"enumDescriptions": [ +"Not set. This will be treated as INHERITED.", +"Scanning is Enabled, but dependent on API enablement.", +"No automatic vulnerability scanning will be performed for this repository." +], +"type": "string" +}, +"enablementState": { +"description": "Output only. State of feature enablement, combining repository enablement config and API enablement state.", +"enum": [ +"ENABLEMENT_STATE_UNSPECIFIED", +"SCANNING_UNSUPPORTED", +"SCANNING_DISABLED", +"SCANNING_ACTIVE" +], +"enumDescriptions": [ +"Enablement state is unclear.", +"Repository does not support vulnerability scanning.", +"Vulnerability scanning is disabled for this repository.", +"Vulnerability scanning is active for this repository." +], +"readOnly": true, +"type": "string" +}, +"enablementStateReason": { +"description": "Output only. Reason for the repository state.", +"readOnly": true, +"type": "string" +}, +"lastEnableTime": { +"description": "Output only. The last time this repository config was enabled.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "YumArtifact": { "description": "A detailed representation of a Yum artifact.", "id": "YumArtifact", diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index 10c1b05c6a..7b002f9c3e 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -555,6 +555,11 @@ "location": "query", "type": "boolean" }, +"ignoreBackupPlanReferences": { +"description": "Optional. If set to true, backupvault deletion will proceed even if there are backup plans referencing the backupvault. The default is 'false'.", +"location": "query", +"type": "boolean" +}, "name": { "description": "Required. Name of the resource.", "location": "path", @@ -1658,7 +1663,7 @@ } } }, -"revision": "20241002", +"revision": "20241017", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -1822,42 +1827,6 @@ }, "type": "object" }, -"AssetLocation": { -"description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", -"id": "AssetLocation", -"properties": { -"ccfeRmsPath": { -"description": "Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata.", -"type": "string" -}, -"expected": { -"$ref": "IsolationExpectations", -"description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." -}, -"extraParameters": { -"description": "Defines extra parameters required for specific asset types.", -"items": { -"$ref": "ExtraParameter" -}, -"type": "array" -}, -"locationData": { -"description": "Contains all kinds of physical location definitions for this asset.", -"items": { -"$ref": "LocationData" -}, -"type": "array" -}, -"parentAsset": { -"description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.", -"items": { -"$ref": "CloudAsset" -}, -"type": "array" -} -}, -"type": "object" -}, "AttachedDisk": { "description": "An instance-attached disk resource.", "id": "AttachedDisk", @@ -2384,7 +2353,7 @@ "type": "string" }, "resourceType": { -"description": "Required. The resource type to which the `BackupPlan` will be applied. Examples include, \"compute.googleapis.com/Instance\" and \"storage.googleapis.com/Bucket\".", +"description": "Required. The resource type to which the `BackupPlan` will be applied. Examples include, \"compute.googleapis.com/Instance\", \"sqladmin.googleapis.com/Instance\" and \"storage.googleapis.com/Bucket\".", "type": "string" }, "state": { @@ -2462,14 +2431,16 @@ "CREATING", "ACTIVE", "DELETING", -"INACTIVE" +"INACTIVE", +"UPDATING" ], "enumDescriptions": [ "State not set.", "The resource is being created.", "The resource has been created and is fully usable.", "The resource is being deleted.", -"The resource has been created but is not usable." +"The resource has been created but is not usable.", +"The resource is being updated." ], "readOnly": true, "type": "string" @@ -2513,13 +2484,15 @@ "ACCESS_RESTRICTION_UNSPECIFIED", "WITHIN_PROJECT", "WITHIN_ORGANIZATION", -"UNRESTRICTED" +"UNRESTRICTED", +"WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA" ], "enumDescriptions": [ -"Access restriction not set.", +"Access restriction not set. If user does not provide any value or pass this value, it will be changed to WITHIN_ORGANIZATION.", "Access to or from resources outside your current project will be denied.", "Access to or from resources outside your current organization will be denied.", -"No access restriction." +"No access restriction.", +"Access to or from resources outside your current organization will be denied except for backup appliance." ], "type": "string" }, @@ -2660,49 +2633,12 @@ }, "type": "object" }, -"BlobstoreLocation": { -"description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", -"id": "BlobstoreLocation", -"properties": { -"policyId": { -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", "properties": {}, "type": "object" }, -"CloudAsset": { -"id": "CloudAsset", -"properties": { -"assetName": { -"type": "string" -}, -"assetType": { -"type": "string" -} -}, -"type": "object" -}, -"CloudAssetComposition": { -"id": "CloudAssetComposition", -"properties": { -"childAsset": { -"items": { -"$ref": "CloudAsset" -}, -"type": "array" -} -}, -"type": "object" -}, "ComputeInstanceBackupProperties": { "description": "ComputeInstanceBackupProperties represents Compute Engine instance backup properties.", "id": "ComputeInstanceBackupProperties", @@ -3170,18 +3106,6 @@ }, "type": "object" }, -"DirectLocationAssignment": { -"id": "DirectLocationAssignment", -"properties": { -"location": { -"items": { -"$ref": "LocationAssignment" -}, -"type": "array" -} -}, -"type": "object" -}, "DisplayDevice": { "description": "A set of Display Device options", "id": "DisplayDevice", @@ -3237,17 +3161,6 @@ }, "type": "object" }, -"ExtraParameter": { -"description": "Defines parameters that should only be used for specific asset types.", -"id": "ExtraParameter", -"properties": { -"regionalMigDistributionPolicy": { -"$ref": "RegionalMigDistributionPolicy", -"description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." -} -}, -"type": "object" -}, "FetchAccessTokenRequest": { "description": "Request message for FetchAccessToken.", "id": "FetchAccessTokenRequest", @@ -3521,131 +3434,6 @@ }, "type": "object" }, -"IsolationExpectations": { -"id": "IsolationExpectations", -"properties": { -"requirementOverride": { -"$ref": "RequirementOverride", -"description": "Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic." -}, -"ziOrgPolicy": { -"enum": [ -"ZI_UNSPECIFIED", -"ZI_UNKNOWN", -"ZI_NOT_REQUIRED", -"ZI_PREFERRED", -"ZI_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"ziRegionPolicy": { -"enum": [ -"ZI_REGION_POLICY_UNSPECIFIED", -"ZI_REGION_POLICY_UNKNOWN", -"ZI_REGION_POLICY_NOT_SET", -"ZI_REGION_POLICY_FAIL_OPEN", -"ZI_REGION_POLICY_FAIL_CLOSED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"ziRegionState": { -"enum": [ -"ZI_REGION_UNSPECIFIED", -"ZI_REGION_UNKNOWN", -"ZI_REGION_NOT_ENABLED", -"ZI_REGION_ENABLED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -}, -"zoneIsolation": { -"deprecated": true, -"description": "Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location.", -"enum": [ -"ZI_UNSPECIFIED", -"ZI_UNKNOWN", -"ZI_NOT_REQUIRED", -"ZI_PREFERRED", -"ZI_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"zoneSeparation": { -"deprecated": true, -"description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.", -"enum": [ -"ZS_UNSPECIFIED", -"ZS_UNKNOWN", -"ZS_NOT_REQUIRED", -"ZS_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -}, -"zsOrgPolicy": { -"enum": [ -"ZS_UNSPECIFIED", -"ZS_UNKNOWN", -"ZS_NOT_REQUIRED", -"ZS_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -}, -"zsRegionState": { -"enum": [ -"ZS_REGION_UNSPECIFIED", -"ZS_REGION_UNKNOWN", -"ZS_REGION_NOT_ENABLED", -"ZS_REGION_ENABLED" -], -"enumDescriptions": [ -"", -"To be used if tracking of the asset ZS-bit is not available", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, "ListBackupPlanAssociationsResponse": { "description": "Response message for List BackupPlanAssociation", "id": "ListBackupPlanAssociationsResponse", @@ -3866,64 +3654,6 @@ }, "type": "object" }, -"LocationAssignment": { -"id": "LocationAssignment", -"properties": { -"location": { -"type": "string" -}, -"locationType": { -"enum": [ -"UNSPECIFIED", -"CLUSTER", -"POP", -"CLOUD_ZONE", -"CLOUD_REGION", -"MULTI_REGION_GEO", -"MULTI_REGION_JURISDICTION", -"GLOBAL", -"OTHER" -], -"enumDescriptions": [ -"", -"1-10: Physical failure domains.", -"", -"11-20: Logical failure domains.", -"", -"", -"", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, -"LocationData": { -"id": "LocationData", -"properties": { -"blobstoreLocation": { -"$ref": "BlobstoreLocation" -}, -"childAssetLocation": { -"$ref": "CloudAssetComposition" -}, -"directLocation": { -"$ref": "DirectLocationAssignment" -}, -"gcpProjectProxy": { -"$ref": "TenantProjectProxy" -}, -"placerLocation": { -"$ref": "PlacerLocation" -}, -"spannerLocation": { -"$ref": "SpannerLocation" -} -}, -"type": "object" -}, "ManagementServer": { "description": "ManagementServer describes a single BackupDR ManagementServer instance.", "id": "ManagementServer", @@ -4344,17 +4074,6 @@ }, "type": "object" }, -"PlacerLocation": { -"description": "Message describing that the location of the customer resource is tied to placer allocations", -"id": "PlacerLocation", -"properties": { -"placerConfig": { -"description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")", -"type": "string" -} -}, -"type": "object" -}, "Policy": { "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", @@ -4386,25 +4105,6 @@ }, "type": "object" }, -"RegionalMigDistributionPolicy": { -"description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", -"id": "RegionalMigDistributionPolicy", -"properties": { -"targetShape": { -"description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum", -"format": "int32", -"type": "integer" -}, -"zones": { -"description": "Cloud zones used by regional MIG to create instances.", -"items": { -"$ref": "ZoneConfiguration" -}, -"type": "array" -} -}, -"type": "object" -}, "RemoveDataSourceRequest": { "description": "Message for deleting a DataSource.", "id": "RemoveDataSourceRequest", @@ -4416,44 +4116,6 @@ }, "type": "object" }, -"RequirementOverride": { -"id": "RequirementOverride", -"properties": { -"ziOverride": { -"enum": [ -"ZI_UNSPECIFIED", -"ZI_UNKNOWN", -"ZI_NOT_REQUIRED", -"ZI_PREFERRED", -"ZI_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"zsOverride": { -"enum": [ -"ZS_UNSPECIFIED", -"ZS_UNKNOWN", -"ZS_NOT_REQUIRED", -"ZS_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, "RestoreBackupRequest": { "description": "Request message for restoring from a Backup.", "id": "RestoreBackupRequest", @@ -4699,26 +4361,6 @@ "properties": {}, "type": "object" }, -"SpannerLocation": { -"id": "SpannerLocation", -"properties": { -"backupName": { -"description": "Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata", -"items": { -"type": "string" -}, -"type": "array" -}, -"dbName": { -"description": "Set of databases used by the resource in format /span//", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "StandardSchedule": { "description": "`StandardSchedule` defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY.", "id": "StandardSchedule", @@ -4887,18 +4529,6 @@ }, "type": "object" }, -"TenantProjectProxy": { -"id": "TenantProjectProxy", -"properties": { -"projectNumbers": { -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest", @@ -5026,15 +4656,6 @@ } }, "type": "object" -}, -"ZoneConfiguration": { -"id": "ZoneConfiguration", -"properties": { -"zone": { -"type": "string" -} -}, -"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json index 367cc28d1e..92fc343841 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json @@ -1795,6 +1795,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/applications/{applicationsId}:testIamPermissions", +"httpMethod": "POST", +"id": "beyondcorp.projects.locations.global.securityGateways.applications.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+/applications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } } @@ -2025,6 +2053,37 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}:getIamPolicy", +"httpMethod": "GET", +"id": "beyondcorp.projects.locations.securityGateways.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists SecurityGateways in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways", @@ -2137,6 +2196,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}:testIamPermissions", +"httpMethod": "POST", +"id": "beyondcorp.projects.locations.securityGateways.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -2202,6 +2289,37 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}:getIamPolicy", +"httpMethod": "GET", +"id": "beyondcorp.projects.locations.securityGateways.applications.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists Applications in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications", @@ -2247,6 +2365,78 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}:setIamPolicy", +"httpMethod": "POST", +"id": "beyondcorp.projects.locations.securityGateways.applications.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +}, +"v": { +"resources": { +"projects": { +"resources": { +"locations": { +"resources": { +"securityGateways": { +"methods": { +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}:setIamPolicy", +"httpMethod": "POST", +"id": "beyondcorp.v.projects.locations.securityGateways.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } } @@ -2257,7 +2447,7 @@ } } }, -"revision": "20241004", +"revision": "20241011", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -3628,7 +3818,7 @@ }, "type": "array" }, -"targetVpcNetwork": { +"targetNetwork": { "description": "Required. The name of the Target VPC network name in the format: `projects/{project}/global/networks/{network}", "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json index 51fe1af533..7a866fbedd 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json @@ -4408,7 +4408,7 @@ } } }, -"revision": "20241004", +"revision": "20241011", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -6766,7 +6766,7 @@ }, "type": "array" }, -"targetVpcNetwork": { +"targetNetwork": { "description": "Required. The name of the Target VPC network name in the format: `projects/{project}/global/networks/{network}", "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index a2120c872e..241eb7ba09 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -253,6 +253,12 @@ "datasetId" ], "parameters": { +"accessPolicyVersion": { +"description": "Optional. The version of the access policy schema to fetch. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for conditional access policy binding in datasets must specify version 3. Dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. This field will be maped to [IAM Policy version] (https://cloud.google.com/iam/docs/policies#versions) and will be used to fetch policy from IAM. If unset or if 0 or 1 value is used for dataset with conditional bindings, access entry with condition will have role string appended by 'withcond' string followed by a hash value. For example : { \"access\": [ { \"role\": \"roles/bigquery.dataViewer_with_conditionalbinding_7a34awqsda\", \"userByEmail\": \"user@example.com\", } ] } Please refer https://cloud.google.com/iam/docs/troubleshooting-withcond for more details.", +"format": "int32", +"location": "query", +"type": "integer" +}, "datasetId": { "description": "Required. Dataset ID of the requested dataset", "location": "path", @@ -304,6 +310,12 @@ "projectId" ], "parameters": { +"accessPolicyVersion": { +"description": "Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Requests with conditional access policy binding in datasets must specify version 3. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be maped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM.", +"format": "int32", +"location": "query", +"type": "integer" +}, "projectId": { "description": "Required. Project ID of the new dataset", "location": "path", @@ -382,6 +394,12 @@ "datasetId" ], "parameters": { +"accessPolicyVersion": { +"description": "Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Operations updating conditional access policy binding in datasets must specify version 3. Some of the operations are : - Adding a new access policy entry with condition. - Removing an access policy entry with condition. - Updating an access policy entry with condition. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be maped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM.", +"format": "int32", +"location": "query", +"type": "integer" +}, "datasetId": { "description": "Required. Dataset ID of the dataset being updated", "location": "path", @@ -456,6 +474,12 @@ "datasetId" ], "parameters": { +"accessPolicyVersion": { +"description": "Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Operations updating conditional access policy binding in datasets must specify version 3. Some of the operations are : - Adding a new access policy entry with condition. - Removing an access policy entry with condition. - Updating an access policy entry with condition. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be maped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM.", +"format": "int32", +"location": "query", +"type": "integer" +}, "datasetId": { "description": "Required. Dataset ID of the dataset being updated", "location": "path", @@ -1985,7 +2009,7 @@ } } }, -"revision": "20240919", +"revision": "20241013", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -3165,6 +3189,10 @@ "items": { "description": "An object that defines dataset access for an entity.", "properties": { +"condition": { +"$ref": "Expr", +"description": "Optional. condition for the binding. If CEL expression in this field is true, this access binding will be considered" +}, "dataset": { "$ref": "DatasetAccessEntry", "description": "[Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation." diff --git a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json index b8af615737..21173b3f37 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json @@ -935,7 +935,7 @@ } } }, -"revision": "20240921", +"revision": "20241023", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -946,6 +946,10 @@ "description": "The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.", "type": "string" }, +"enableGeminiInBigquery": { +"description": "Optional. This field controls if \"Gemini in BigQuery\" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. \"Gemini in BigQuery\" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to \"Gemini in BigQuery\" features.", +"type": "boolean" +}, "jobType": { "description": "Which type of jobs will use the reservation.", "enum": [ @@ -994,7 +998,7 @@ "id": "Autoscale", "properties": { "currentSlots": { -"description": "Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].", +"description": "Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. Note: after users reduce max_slots, it may take a while before it can be propagated, so current_slots may stay in the original value and could be larger than max_slots for that brief period (less than one minute)", "format": "int64", "readOnly": true, "type": "string" @@ -1326,6 +1330,13 @@ false "description": "If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.", "type": "boolean" }, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The labels associated with this reservation. You can use these to organize and group your reservations. You can set this property when inserting or updating a reservation.", +"type": "object" +}, "multiRegionAuxiliary": { "description": "Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json index ad352dea18..7c49d23791 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json @@ -2194,7 +2194,7 @@ } } }, -"revision": "20240918", +"revision": "20241008", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -2325,7 +2325,7 @@ "id": "AutomatedBackupPolicy", "properties": { "frequency": { -"description": "Required. How frequently automated backups should occur. The only supported value at this time is 24 hours.", +"description": "How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours.", "format": "google-duration", "type": "string" }, @@ -3174,7 +3174,7 @@ "type": "object" }, "GoogleBigtableAdminV2TypeAggregate": { -"description": "A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` .", +"description": "A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` .", "id": "GoogleBigtableAdminV2TypeAggregate", "properties": { "hllppUniqueCount": { @@ -3183,7 +3183,7 @@ }, "inputType": { "$ref": "Type", -"description": "Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs." +"description": "Type of the inputs that are accumulated by this `Aggregate`. Use `AddInput` mutations to accumulate new inputs." }, "max": { "$ref": "GoogleBigtableAdminV2TypeAggregateMax", @@ -3195,7 +3195,7 @@ }, "stateType": { "$ref": "Type", -"description": "Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding.", +"description": "Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen.", "readOnly": true }, "sum": { @@ -3252,13 +3252,13 @@ "properties": { "encoding": { "$ref": "GoogleBigtableAdminV2TypeBytesEncoding", -"description": "The encoding to use when converting to/from lower level types." +"description": "The encoding to use when converting to or from lower level types." } }, "type": "object" }, "GoogleBigtableAdminV2TypeBytesEncoding": { -"description": "Rules used to convert to/from lower level types.", +"description": "Rules used to convert to or from lower level types.", "id": "GoogleBigtableAdminV2TypeBytesEncoding", "properties": { "raw": { @@ -3269,7 +3269,7 @@ "type": "object" }, "GoogleBigtableAdminV2TypeBytesEncodingRaw": { -"description": "Leaves the value \"as-is\" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A", +"description": "Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported.", "id": "GoogleBigtableAdminV2TypeBytesEncodingRaw", "properties": {}, "type": "object" @@ -3298,13 +3298,13 @@ "properties": { "encoding": { "$ref": "GoogleBigtableAdminV2TypeInt64Encoding", -"description": "The encoding to use when converting to/from lower level types." +"description": "The encoding to use when converting to or from lower level types." } }, "type": "object" }, "GoogleBigtableAdminV2TypeInt64Encoding": { -"description": "Rules used to convert to/from lower level types.", +"description": "Rules used to convert to or from lower level types.", "id": "GoogleBigtableAdminV2TypeInt64Encoding", "properties": { "bigEndianBytes": { @@ -3315,7 +3315,7 @@ "type": "object" }, "GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes": { -"description": "Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Order-preserving? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`", +"description": "Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`", "id": "GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes", "properties": { "bytesType": { @@ -3347,13 +3347,13 @@ "properties": { "encoding": { "$ref": "GoogleBigtableAdminV2TypeStringEncoding", -"description": "The encoding to use when converting to/from lower level types." +"description": "The encoding to use when converting to or from lower level types." } }, "type": "object" }, "GoogleBigtableAdminV2TypeStringEncoding": { -"description": "Rules used to convert to/from lower level types.", +"description": "Rules used to convert to or from lower level types.", "id": "GoogleBigtableAdminV2TypeStringEncoding", "properties": { "utf8Bytes": { @@ -3369,7 +3369,7 @@ "type": "object" }, "GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes": { -"description": "UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)`", +"description": "UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)`", "id": "GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes", "properties": {}, "type": "object" @@ -4302,7 +4302,7 @@ "type": "object" }, "Type": { -"description": "`Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING(\"-00001\") > STRING(\"00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java?", +"description": "`Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both \"{'foo': '1', 'bar': '2'}\" and \"{'bar': '2', 'foo': '1'}\" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING(\"-00001\") > STRING(\"00001\")`.", "id": "Type", "properties": { "aggregateType": { diff --git a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json index ef1d87d911..6b84d35acb 100644 --- a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json @@ -551,7 +551,7 @@ } } }, -"revision": "20240701", +"revision": "20241018", "rootUrl": "https://binaryauthorization.googleapis.com/", "schemas": { "AdmissionRule": { @@ -589,7 +589,6 @@ "type": "string" }, "requireAttestationsBy": { -"description": "Optional. The resource names of the attestors that must attest to a container image, in the format `projects/*/attestors/*`. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 4c5eab7cbd..c0a2798dca 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -1344,7 +1344,7 @@ } } }, -"revision": "20241008", +"revision": "20241020", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -1999,7 +1999,7 @@ "Default value. Unspecified.", "A user opens a dialog.", "A user clicks an interactive element of a dialog. For example, a user fills out information in a dialog and clicks a button to submit the information.", -"A user closes a dialog without submitting information, or the dialog is canceled." +"A user closes a dialog without submitting information. The Chat app only receives this interaction event when users click the close icon in the top right corner of the dialog. When the user closes the dialog by other means (such as refreshing the browser, clicking outside the dialog box, or pressing the escape key), no event is sent. ." ], "type": "string" }, @@ -2281,6 +2281,24 @@ "text": { "description": "The text displayed inside the button.", "type": "string" +}, +"type": { +"description": "Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. [Google Chat apps](https://developers.google.com/workspace/chat):", +"enum": [ +"TYPE_UNSPECIFIED", +"OUTLINED", +"FILLED", +"FILLED_TONAL", +"BORDERLESS" +], +"enumDescriptions": [ +"Don't use. Unspecified.", +"Outlined buttons are medium-emphasis buttons. They usually contain actions that are important, but aren\u2019t the primary action in a Chat app or an add-on.", +"A filled button has a container with a solid color. It has the most visual impact and is recommended for the important and primary action in a Chat app or an add-on.", +"A filled tonal button is an alternative middle ground between filled and outlined buttons. They\u2019re useful in contexts where a lower-priority button requires slightly more emphasis than an outline button would give.", +"A button does not have an invisible container in its default state. It is often used for the lowest priority actions, especially when presenting multiple options." +], +"type": "string" } }, "type": "object" @@ -2429,6 +2447,97 @@ }, "type": "object" }, +"GoogleAppsCardV1Chip": { +"description": "A text, icon, or text and icon chip that users can click. [Google Chat apps](https://developers.google.com/workspace/chat):", +"id": "GoogleAppsCardV1Chip", +"properties": { +"altText": { +"description": "The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: \"Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat\".", +"type": "string" +}, +"disabled": { +"description": "Whether the chip is in an inactive state and ignores user actions. Defaults to `false`.", +"type": "boolean" +}, +"enabled": { +"deprecated": true, +"description": "Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead.", +"type": "boolean" +}, +"icon": { +"$ref": "GoogleAppsCardV1Icon", +"description": "The icon image. If both `icon` and `text` are set, then the icon appears before the text." +}, +"label": { +"description": "The text displayed inside the chip.", +"type": "string" +}, +"onClick": { +"$ref": "GoogleAppsCardV1OnClick", +"description": "Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function." +} +}, +"type": "object" +}, +"GoogleAppsCardV1ChipList": { +"description": "A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Chat apps](https://developers.google.com/workspace/chat):", +"id": "GoogleAppsCardV1ChipList", +"properties": { +"chips": { +"description": "An array of chips.", +"items": { +"$ref": "GoogleAppsCardV1Chip" +}, +"type": "array" +}, +"layout": { +"description": "Specified chip list layout.", +"enum": [ +"LAYOUT_UNSPECIFIED", +"WRAPPED", +"HORIZONTAL_SCROLLABLE" +], +"enumDescriptions": [ +"Don't use. Unspecified.", +"Default value. The chip list wraps to the next line if there isn't enough horizontal space.", +"The chips scroll horizontally if they don't fit in the available space." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleAppsCardV1CollapseControl": { +"description": "Represent an expand and collapse control. [Google Chat apps](https://developers.google.com/workspace/chat):", +"id": "GoogleAppsCardV1CollapseControl", +"properties": { +"collapseButton": { +"$ref": "GoogleAppsCardV1Button", +"description": "Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used." +}, +"expandButton": { +"$ref": "GoogleAppsCardV1Button", +"description": "Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used." +}, +"horizontalAlignment": { +"description": "The horizontal alignment of the expand and collapse button.", +"enum": [ +"HORIZONTAL_ALIGNMENT_UNSPECIFIED", +"START", +"CENTER", +"END" +], +"enumDescriptions": [ +"Don't use. Unspecified.", +"Default value. Aligns widgets to the start position of the column. For left-to-right layouts, aligns to the left. For right-to-left layouts, aligns to the right.", +"Aligns widgets to the center of the column.", +"Aligns widgets to the end position of the column. For left-to-right layouts, aligns widgets to the right. For right-to-left layouts, aligns widgets to the left." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleAppsCardV1Column": { "description": "A column. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend)", "id": "GoogleAppsCardV1Column", @@ -2819,6 +2928,10 @@ "openLink": { "$ref": "GoogleAppsCardV1OpenLink", "description": "If specified, this `onClick` triggers an open link action." +}, +"overflowMenu": { +"$ref": "GoogleAppsCardV1OverflowMenu", +"description": "If specified, this `onClick` opens an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat):" } }, "type": "object" @@ -2858,6 +2971,43 @@ }, "type": "object" }, +"GoogleAppsCardV1OverflowMenu": { +"description": "A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Chat apps](https://developers.google.com/workspace/chat):", +"id": "GoogleAppsCardV1OverflowMenu", +"properties": { +"items": { +"description": "Required. The list of menu options.", +"items": { +"$ref": "GoogleAppsCardV1OverflowMenuItem" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleAppsCardV1OverflowMenuItem": { +"description": "An option that users can invoke in an overflow menu. [Google Chat apps](https://developers.google.com/workspace/chat):", +"id": "GoogleAppsCardV1OverflowMenuItem", +"properties": { +"disabled": { +"description": "Whether the menu option is disabled. Defaults to false.", +"type": "boolean" +}, +"onClick": { +"$ref": "GoogleAppsCardV1OnClick", +"description": "Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled." +}, +"startIcon": { +"$ref": "GoogleAppsCardV1Icon", +"description": "The icon displayed in front of the text." +}, +"text": { +"description": "Required. The text that identifies or describes the item to users.", +"type": "string" +} +}, +"type": "object" +}, "GoogleAppsCardV1PlatformDataSource": { "description": "For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat):", "id": "GoogleAppsCardV1PlatformDataSource", @@ -2885,6 +3035,10 @@ "description": "A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1Section", "properties": { +"collapseControl": { +"$ref": "GoogleAppsCardV1CollapseControl", +"description": "Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. [Google Chat apps](https://developers.google.com/workspace/chat):" +}, "collapsible": { "description": "Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`.", "type": "boolean" @@ -3114,6 +3268,11 @@ "description": "A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1TextParagraph", "properties": { +"maxLines": { +"description": "The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. [Google Chat apps](https://developers.google.com/workspace/chat):", +"format": "int32", +"type": "integer" +}, "text": { "description": "The text that's shown in the widget.", "type": "string" @@ -3129,6 +3288,10 @@ "$ref": "GoogleAppsCardV1ButtonList", "description": "A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` \"buttonList\": { \"buttons\": [ { \"text\": \"Edit\", \"color\": { \"red\": 0, \"green\": 0, \"blue\": 1, }, \"disabled\": true, }, { \"icon\": { \"knownIcon\": \"INVITE\", \"altText\": \"check calendar\" }, \"onClick\": { \"openLink\": { \"url\": \"https://example.com/calendar\" } } } ] } ```" }, +"chipList": { +"$ref": "GoogleAppsCardV1ChipList", +"description": "A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` \"chipList\": { \"chips\": [ { \"text\": \"Edit\", \"disabled\": true, }, { \"icon\": { \"knownIcon\": \"INVITE\", \"altText\": \"check calendar\" }, \"onClick\": { \"openLink\": { \"url\": \"https://example.com/calendar\" } } } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat):" +}, "columns": { "$ref": "GoogleAppsCardV1Columns", "description": "Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` \"columns\": { \"columnItems\": [ { \"horizontalSizeStyle\": \"FILL_AVAILABLE_SPACE\", \"horizontalAlignment\": \"CENTER\", \"verticalAlignment\": \"CENTER\", \"widgets\": [ { \"textParagraph\": { \"text\": \"First column text paragraph\" } } ] }, { \"horizontalSizeStyle\": \"FILL_AVAILABLE_SPACE\", \"horizontalAlignment\": \"CENTER\", \"verticalAlignment\": \"CENTER\", \"widgets\": [ { \"textParagraph\": { \"text\": \"Second column text paragraph\" } } ] } ] } ```" @@ -3192,6 +3355,10 @@ "$ref": "GoogleAppsCardV1ButtonList", "description": "ButtonList widget." }, +"chipList": { +"$ref": "GoogleAppsCardV1ChipList", +"description": "ChipList widget. [Google Chat apps](https://developers.google.com/workspace/chat):" +}, "dateTimePicker": { "$ref": "GoogleAppsCardV1DateTimePicker", "description": "DateTimePicker widget." diff --git a/googleapiclient/discovery_cache/documents/checks.v1alpha.json b/googleapiclient/discovery_cache/documents/checks.v1alpha.json index c3e0d8e976..ceb624da8e 100644 --- a/googleapiclient/discovery_cache/documents/checks.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/checks.v1alpha.json @@ -444,7 +444,7 @@ } } }, -"revision": "20240904", +"revision": "20241025", "rootUrl": "https://checks.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -705,7 +705,10 @@ "DATA_MONITORING_OUTDATED_SDK_VERSION", "DATA_MONITORING_CRITICAL_SDK_ISSUE", "PRIVACY_POLICY_DATA_TYPE_SENSITIVE_INFO", -"DATA_MONITORING_PII_LOGCAT_LEAK" +"DATA_MONITORING_PII_LOGCAT_LEAK", +"DATA_MONITORING_MINIMIZE_PERMISSION_MEDIA", +"DATA_MONITORING_MINIMIZE_PERMISSION_CAMERA", +"DATA_MONITORING_MINIMIZE_PERMISSION_DOCUMENTS" ], "enumDescriptions": [ "Not specified.", @@ -796,7 +799,10 @@ "Checks if there are any outdated SDKs.", "Checks if there are any SDKs with critical issues.", "Checks if the Sensitive Information data type declaration matches usage.", -"Checks if there were any PII leaked to device logs." +"Checks if there were any PII leaked to device logs.", +"Checks if there are media (photo and video) permissions that are considered sensitive and should be minimized for Android.", +"Checks if there are camera use permissions that are considered sensitive and should be minimized for Android.", +"Checks if there are documents and file permissions that are considered sensitive and should be minimized for Android." ], "type": "string" } @@ -924,6 +930,7 @@ "DATA_TYPE_FITNESS_INFO", "DATA_TYPE_EMAILS", "DATA_TYPE_TEXT_MESSAGES", +"DATA_TYPE_OTHER_IN_APP_MESSAGES", "DATA_TYPE_PHOTOS", "DATA_TYPE_VIDEOS", "DATA_TYPE_VOICE_OR_SOUND_RECORDINGS", @@ -964,6 +971,7 @@ "Information about a user's fitness, such as exercise or other physical activity.", "A user's emails including the email subject line, sender, recipients, and the content of the email.", "A user's text messages including the sender, recipients, and the content of the message.", +"Any other types of messages. For example, instant messages or chat content.", "A user's photos.", "A user's videos.", "A user's voice such as a voicemail or a sound recording.", @@ -1298,6 +1306,7 @@ "DATA_TYPE_FITNESS_INFO", "DATA_TYPE_EMAILS", "DATA_TYPE_TEXT_MESSAGES", +"DATA_TYPE_OTHER_IN_APP_MESSAGES", "DATA_TYPE_PHOTOS", "DATA_TYPE_VIDEOS", "DATA_TYPE_VOICE_OR_SOUND_RECORDINGS", @@ -1338,6 +1347,7 @@ "Information about a user's fitness, such as exercise or other physical activity.", "A user's emails including the email subject line, sender, recipients, and the content of the email.", "A user's text messages including the sender, recipients, and the content of the message.", +"Any other types of messages. For example, instant messages or chat content.", "A user's photos.", "A user's videos.", "A user's voice such as a voicemail or a sound recording.", diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index d75f655df4..480249b8bf 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -591,12 +591,12 @@ "type": "string" }, "filter": { -"description": "Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id * manifest_versions", +"description": "Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id * manifest_versions * risk_score", "location": "query", "type": "string" }, "orderBy": { -"description": "Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id * manifest_versions", +"description": "Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id * manifest_versions * risk_score", "location": "query", "type": "string" }, @@ -1172,7 +1172,7 @@ } } }, -"revision": "20241003", +"revision": "20241023", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { @@ -2849,6 +2849,11 @@ }, "readOnly": true, "type": "array" +}, +"riskAssessment": { +"$ref": "GoogleChromeManagementV1RiskAssessmentData", +"description": "Output only. If available, the risk assessment data about this extension.", +"readOnly": true } }, "type": "object" @@ -3419,6 +3424,96 @@ }, "type": "object" }, +"GoogleChromeManagementV1RiskAssessment": { +"description": "Risk assessment for a Chrome extension.", +"id": "GoogleChromeManagementV1RiskAssessment", +"properties": { +"assessment": { +"description": "Risk assessment for the extension. Currently, this is a numerical value, and its interpretation is specific to each risk assessment provider.", +"type": "string" +}, +"detailsUrl": { +"description": "A URL that a user can navigate to for more information about the risk assessment.", +"type": "string" +}, +"version": { +"description": "The version of the extension that this assessment applies to.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleChromeManagementV1RiskAssessmentData": { +"description": "Risk assessment data about an extension/app.", +"id": "GoogleChromeManagementV1RiskAssessmentData", +"properties": { +"entries": { +"description": "Individual risk assessments.", +"items": { +"$ref": "GoogleChromeManagementV1RiskAssessmentEntry" +}, +"type": "array" +}, +"overallRiskLevel": { +"description": "Overall assessed risk level across all entries. This will be the highest risk level from all entries.", +"enum": [ +"RISK_LEVEL_UNSPECIFIED", +"RISK_LEVEL_LOW", +"RISK_LEVEL_MEDIUM", +"RISK_LEVEL_HIGH" +], +"enumDescriptions": [ +"Risk level not specified.", +"Extension that represents a low risk.", +"Extension that represents a medium risk.", +"Extension that represents a high risk." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleChromeManagementV1RiskAssessmentEntry": { +"description": "One risk assessment entry.", +"id": "GoogleChromeManagementV1RiskAssessmentEntry", +"properties": { +"provider": { +"description": "The risk assessment provider from which this entry comes from.", +"enum": [ +"RISK_ASSESSMENT_PROVIDER_UNSPECIFIED", +"RISK_ASSESSMENT_PROVIDER_CRXCAVATOR", +"RISK_ASSESSMENT_PROVIDER_SPIN_AI" +], +"enumDescriptions": [ +"Default value when no provider is specified.", +"CRXcavator.", +"Spin.Ai." +], +"type": "string" +}, +"riskAssessment": { +"$ref": "GoogleChromeManagementV1RiskAssessment", +"description": "The details of the provider's risk assessment." +}, +"riskLevel": { +"description": "The bucketed risk level for the risk assessment.", +"enum": [ +"RISK_LEVEL_UNSPECIFIED", +"RISK_LEVEL_LOW", +"RISK_LEVEL_MEDIUM", +"RISK_LEVEL_HIGH" +], +"enumDescriptions": [ +"Risk level not specified.", +"Extension that represents a low risk.", +"Extension that represents a medium risk.", +"Extension that represents a high risk." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleChromeManagementV1RuntimeCountersReport": { "description": "Runtime counters retrieved from CPU. Currently the runtime counters telemetry is only supported by Intel vPro PSR on Gen 14+.", "id": "GoogleChromeManagementV1RuntimeCountersReport", diff --git a/googleapiclient/discovery_cache/documents/cloudbilling.v1.json b/googleapiclient/discovery_cache/documents/cloudbilling.v1.json index fcaecff400..58959ceae9 100644 --- a/googleapiclient/discovery_cache/documents/cloudbilling.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbilling.v1.json @@ -751,7 +751,7 @@ } } }, -"revision": "20240614", +"revision": "20241011", "rootUrl": "https://cloudbilling.googleapis.com/", "schemas": { "AggregationInfo": { @@ -844,6 +844,10 @@ "description": "A billing account in the [Google Cloud Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects.", "id": "BillingAccount", "properties": { +"currencyCode": { +"description": "Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as `USD`. Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account.", +"type": "string" +}, "displayName": { "description": "The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json index 3ce3677ea5..f899341544 100644 --- a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json @@ -139,7 +139,7 @@ ] }, "listSubscribers": { -"description": "Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.", +"description": "Lists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.", "flatPath": "v1/accounts/{accountsId}:listSubscribers", "httpMethod": "GET", "id": "cloudchannel.accounts.listSubscribers", @@ -148,12 +148,17 @@ ], "parameters": { "account": { -"description": "Optional. Resource name of the account.", +"description": "Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, "type": "string" }, +"integrator": { +"description": "Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.", +"location": "query", +"type": "string" +}, "pageSize": { "description": "Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000.", "format": "int32", @@ -231,7 +236,7 @@ ] }, "register": { -"description": "Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.", +"description": "Registers a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or integrator. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.", "flatPath": "v1/accounts/{accountsId}:register", "httpMethod": "POST", "id": "cloudchannel.accounts.register", @@ -240,7 +245,7 @@ ], "parameters": { "account": { -"description": "Optional. Resource name of the account.", +"description": "Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -259,7 +264,7 @@ ] }, "unregister": { -"description": "Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.", +"description": "Unregisters a service account with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.", "flatPath": "v1/accounts/{accountsId}:unregister", "httpMethod": "POST", "id": "cloudchannel.accounts.unregister", @@ -268,7 +273,7 @@ ], "parameters": { "account": { -"description": "Optional. Resource name of the account.", +"description": "Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -1900,7 +1905,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. A token identifying a page of results beyond the first page. Obtained through ListSkuGroups.next_page_token of the previous CloudChannelService.ListSkuGroups call.", +"description": "Optional. A token identifying a page of results beyond the first page. Obtained through ListSkuGroupsResponse.next_page_token of the previous CloudChannelService.ListSkuGroups call.", "location": "query", "type": "string" }, @@ -1940,7 +1945,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. A token identifying a page of results beyond the first page. Obtained through ListSkuGroupBillableSkus.next_page_token of the previous CloudChannelService.ListSkuGroupBillableSkus call.", +"description": "Optional. A token identifying a page of results beyond the first page. Obtained through ListSkuGroupBillableSkusResponse.next_page_token of the previous CloudChannelService.ListSkuGroupBillableSkus call.", "location": "query", "type": "string" }, @@ -1966,6 +1971,107 @@ } } }, +"integrators": { +"methods": { +"listSubscribers": { +"description": "Lists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.", +"flatPath": "v1/integrators/{integratorsId}:listSubscribers", +"httpMethod": "GET", +"id": "cloudchannel.integrators.listSubscribers", +"parameterOrder": [ +"integrator" +], +"parameters": { +"account": { +"description": "Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.", +"location": "query", +"type": "string" +}, +"integrator": { +"description": "Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.", +"location": "path", +"pattern": "^integrators/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` must match the call that provided the page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+integrator}:listSubscribers", +"response": { +"$ref": "GoogleCloudChannelV1ListSubscribersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/apps.order" +] +}, +"registerSubscriber": { +"description": "Registers a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or integrator. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.", +"flatPath": "v1/integrators/{integratorsId}:registerSubscriber", +"httpMethod": "POST", +"id": "cloudchannel.integrators.registerSubscriber", +"parameterOrder": [ +"integrator" +], +"parameters": { +"integrator": { +"description": "Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.", +"location": "path", +"pattern": "^integrators/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+integrator}:registerSubscriber", +"request": { +"$ref": "GoogleCloudChannelV1RegisterSubscriberRequest" +}, +"response": { +"$ref": "GoogleCloudChannelV1RegisterSubscriberResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/apps.order" +] +}, +"unregisterSubscriber": { +"description": "Unregisters a service account with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.", +"flatPath": "v1/integrators/{integratorsId}:unregisterSubscriber", +"httpMethod": "POST", +"id": "cloudchannel.integrators.unregisterSubscriber", +"parameterOrder": [ +"integrator" +], +"parameters": { +"integrator": { +"description": "Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.", +"location": "path", +"pattern": "^integrators/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+integrator}:unregisterSubscriber", +"request": { +"$ref": "GoogleCloudChannelV1UnregisterSubscriberRequest" +}, +"response": { +"$ref": "GoogleCloudChannelV1UnregisterSubscriberResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/apps.order" +] +} +} +}, "operations": { "methods": { "cancel": { @@ -2183,7 +2289,7 @@ } } }, -"revision": "20240913", +"revision": "20241024", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { @@ -2335,7 +2441,7 @@ "type": "object" }, "GoogleCloudChannelV1ChangeParametersRequest": { -"description": "Request message for CloudChannelService.ChangeParametersRequest.", +"description": "Request message for CloudChannelService.ChangeParameters.", "id": "GoogleCloudChannelV1ChangeParametersRequest", "properties": { "parameters": { @@ -3547,7 +3653,7 @@ "type": "array" }, "nextPageToken": { -"description": "A token to retrieve the next page of results. Pass to ListSkuGroupBillableSkus.page_token to obtain that page.", +"description": "A token to retrieve the next page of results. Pass to ListSkuGroupBillableSkusRequest.page_token to obtain that page.", "type": "string" } }, @@ -3558,7 +3664,7 @@ "id": "GoogleCloudChannelV1ListSkuGroupsResponse", "properties": { "nextPageToken": { -"description": "A token to retrieve the next page of results. Pass to ListSkuGroups.page_token to obtain that page.", +"description": "A token to retrieve the next page of results. Pass to ListSkuGroupsRequest.page_token to obtain that page.", "type": "string" }, "skuGroups": { @@ -4243,6 +4349,14 @@ "description": "Request Message for RegisterSubscriber.", "id": "GoogleCloudChannelV1RegisterSubscriberRequest", "properties": { +"account": { +"description": "Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.", +"type": "string" +}, +"integrator": { +"description": "Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.", +"type": "string" +}, "serviceAccount": { "description": "Required. Service account that provides subscriber access to the registered topic.", "type": "string" @@ -4817,6 +4931,14 @@ "description": "Request Message for UnregisterSubscriber.", "id": "GoogleCloudChannelV1UnregisterSubscriberRequest", "properties": { +"account": { +"description": "Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.", +"type": "string" +}, +"integrator": { +"description": "Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.", +"type": "string" +}, "serviceAccount": { "description": "Required. Service account to unregister from subscriber access to the topic.", "type": "string" @@ -5091,6 +5213,10 @@ }, "type": "array" }, +"priceReferenceId": { +"description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Yet to be implemented: this field is currently not evaluated in the API if populated in a request.", +"type": "string" +}, "provisionedService": { "$ref": "GoogleCloudChannelV1alpha1ProvisionedService", "description": "Output only. Service provisioning details for the entitlement.", diff --git a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json index c2483be0b3..3e7edc334d 100644 --- a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json @@ -138,6 +138,64 @@ "resources": { "customers": { "methods": { +"create": { +"description": "Creates a new customer.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/customers", +"httpMethod": "POST", +"id": "cloudcontrolspartner.organizations.locations.customers.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"customerId": { +"description": "Required. The customer id to use for the customer, which will become the final component of the customer's resource name. The specified value must be a valid Google cloud organization id.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent resource Format: `organizations/{organization}/locations/{location}`", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/customers", +"request": { +"$ref": "Customer" +}, +"response": { +"$ref": "Customer" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Delete details of a single customer", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}", +"httpMethod": "DELETE", +"id": "cloudcontrolspartner.organizations.locations.customers.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. name of the resource to be deleted format: name=organizations/*/locations/*/customers/*", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/customers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets details of a single customer", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}", @@ -208,6 +266,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"patch": { +"description": "Update details of a single customer", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}", +"httpMethod": "PATCH", +"id": "cloudcontrolspartner.organizations.locations.customers.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/customers/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to update", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "Customer" +}, +"response": { +"$ref": "Customer" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -484,7 +576,7 @@ } } }, -"revision": "20240904", +"revision": "20241024", "rootUrl": "https://cloudcontrolspartner.googleapis.com/", "schemas": { "AccessApprovalRequest": { @@ -609,6 +701,11 @@ "name": { "description": "Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`", "type": "string" +}, +"organizationDomain": { +"description": "Output only. The customer organization domain, extracted from CRM Organization\u2019s display_name field. e.g. \"google.com\"", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -758,6 +855,12 @@ }, "type": "object" }, +"Empty": { +"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", +"id": "Empty", +"properties": {}, +"type": "object" +}, "Gcloud": { "description": "Remediation instructions to resolve violation via gcloud cli", "id": "Gcloud", diff --git a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json index bf45c9d57e..6ecddafe1b 100644 --- a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json +++ b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json @@ -138,6 +138,64 @@ "resources": { "customers": { "methods": { +"create": { +"description": "Creates a new customer.", +"flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/customers", +"httpMethod": "POST", +"id": "cloudcontrolspartner.organizations.locations.customers.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"customerId": { +"description": "Required. The customer id to use for the customer, which will become the final component of the customer's resource name. The specified value must be a valid Google cloud organization id.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent resource Format: `organizations/{organization}/locations/{location}`", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/customers", +"request": { +"$ref": "Customer" +}, +"response": { +"$ref": "Customer" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Delete details of a single customer", +"flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}", +"httpMethod": "DELETE", +"id": "cloudcontrolspartner.organizations.locations.customers.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. name of the resource to be deleted format: name=organizations/*/locations/*/customers/*", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/customers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets details of a single customer", "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}", @@ -208,6 +266,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"patch": { +"description": "Update details of a single customer", +"flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}", +"httpMethod": "PATCH", +"id": "cloudcontrolspartner.organizations.locations.customers.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/customers/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to update", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"request": { +"$ref": "Customer" +}, +"response": { +"$ref": "Customer" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -484,7 +576,7 @@ } } }, -"revision": "20240904", +"revision": "20241024", "rootUrl": "https://cloudcontrolspartner.googleapis.com/", "schemas": { "AccessApprovalRequest": { @@ -609,6 +701,11 @@ "name": { "description": "Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`", "type": "string" +}, +"organizationDomain": { +"description": "Output only. The customer organization domain, extracted from CRM Organization\u2019s display_name field. e.g. \"google.com\"", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -758,6 +855,12 @@ }, "type": "object" }, +"Empty": { +"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", +"id": "Empty", +"properties": {}, +"type": "object" +}, "Gcloud": { "description": "Remediation instructions to resolve violation via gcloud cli", "id": "Gcloud", diff --git a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json index 78b42cb09d..97f0a66ea1 100644 --- a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json +++ b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json @@ -2289,7 +2289,7 @@ } } }, -"revision": "20241002", +"revision": "20241010", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { @@ -2442,6 +2442,27 @@ "properties": {}, "type": "object" }, +"AssociatedEntities": { +"description": "Information about entities associated with a `Target`.", +"id": "AssociatedEntities", +"properties": { +"anthosClusters": { +"description": "Optional. Information specifying Anthos clusters as associated entities.", +"items": { +"$ref": "AnthosCluster" +}, +"type": "array" +}, +"gkeClusters": { +"description": "Optional. Information specifying GKE clusters as associated entities.", +"items": { +"$ref": "GkeCluster" +}, +"type": "array" +} +}, +"type": "object" +}, "AuditConfig": { "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "AuditConfig", @@ -3989,6 +4010,10 @@ true "description": "Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources.", "type": "string" }, +"routeDestinations": { +"$ref": "RouteDestinations", +"description": "Optional. Route destinations allow configuring the Gateway API HTTPRoute to be deployed to additional clusters. This option is available for multi-cluster service mesh set ups that require the route to exist in the clusters that call the service. If unspecified, the HTTPRoute will only be deployed to the Target cluster." +}, "routeUpdateWaitTime": { "description": "Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time.", "format": "google-duration", @@ -6308,6 +6333,24 @@ true }, "type": "object" }, +"RouteDestinations": { +"description": "Information about route destinations for the Gateway API service mesh.", +"id": "RouteDestinations", +"properties": { +"destinationIds": { +"description": "Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and \"@self\" to include the Target cluster.", +"items": { +"type": "string" +}, +"type": "array" +}, +"propagateService": { +"description": "Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified.", +"type": "boolean" +} +}, +"type": "object" +}, "RuntimeConfig": { "description": "RuntimeConfig contains the runtime specific configurations for a deployment strategy.", "id": "RuntimeConfig", @@ -6622,6 +6665,13 @@ true "$ref": "AnthosCluster", "description": "Optional. Information specifying an Anthos Cluster." }, +"associatedEntities": { +"additionalProperties": { +"$ref": "AssociatedEntities" +}, +"description": "Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", +"type": "object" +}, "createTime": { "description": "Output only. Time at which the `Target` was created.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json index efb6119b5e..e958d6e9ca 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json @@ -1990,7 +1990,7 @@ } } }, -"revision": "20240924", +"revision": "20241010", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json index c206e6144c..4486a9aa48 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json @@ -2013,9 +2013,64 @@ } } } +}, +"policies": { +"methods": { +"get": { +"description": "Get a Policy", +"flatPath": "v1beta1/policies/{policiesId}", +"httpMethod": "GET", +"id": "cloudidentity.policies.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the policy to retrieve. Format: \"policies/{policy}\".", +"location": "path", +"pattern": "^policies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Policy" } }, -"revision": "20241001", +"list": { +"description": "List Policies", +"flatPath": "v1beta1/policies", +"httpMethod": "GET", +"id": "cloudidentity.policies.list", +"parameterOrder": [], +"parameters": { +"filter": { +"description": "Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.name = 'settings/gmail.*' Policies can be filtered by setting type with this expression: setting.name = '*.service_status' A maximum of one of the above setting.name clauses can be used. Policies can be filtered by customer with this expression: customer = \"customers/{customer}\" Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. A maximum of one customer clause can be used. The above clauses can only be combined together in a single filter expression with the AND operator.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of results to return. The service may return fewer than this value. If omitted (or defaulted to zero) the server will default to 50. The maximum allowed value is 100, though requests with page_size greater than that will be interpreted as 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The pagination token received from a prior call to PoliciesService.ListPolicies to retrieve the next page of results. When paginating, all other parameters provided to `ListPoliciesRequest` must match the call that provided the page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/policies", +"response": { +"$ref": "ListPoliciesResponse" +} +} +} +} +}, +"revision": "20241021", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { @@ -4379,6 +4434,24 @@ }, "type": "object" }, +"ListPoliciesResponse": { +"description": "The response message for PoliciesService.ListPolicies.", +"id": "ListPoliciesResponse", +"properties": { +"nextPageToken": { +"description": "The pagination token to retrieve the next page of results. If this field is empty, there are no subsequent pages.", +"type": "string" +}, +"policies": { +"description": "The results", +"items": { +"$ref": "Policy" +}, +"type": "array" +} +}, +"type": "object" +}, "ListUserInvitationsResponse": { "description": "Response message for UserInvitation listing request.", "id": "ListUserInvitationsResponse", @@ -4805,6 +4878,70 @@ }, "type": "object" }, +"Policy": { +"description": "A Policy resource binds an instance of a single Setting with the scope of a PolicyQuery. The Setting instance will be applied to all entities that satisfy the query.", +"id": "Policy", +"properties": { +"customer": { +"description": "Immutable. Customer that the Policy belongs to. The value is in the format 'customers/{customerId}'. The `customerId` must begin with \"C\" To find your customer ID in Admin Console see https://support.google.com/a/answer/10070793.", +"type": "string" +}, +"name": { +"description": "Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}.", +"readOnly": true, +"type": "string" +}, +"policyQuery": { +"$ref": "PolicyQuery", +"description": "Required. The PolicyQuery the Setting applies to." +}, +"setting": { +"$ref": "Setting", +"description": "Required. The Setting configured by this Policy." +}, +"type": { +"description": "Output only. The type of the policy.", +"enum": [ +"POLICY_TYPE_UNSPECIFIED", +"SYSTEM", +"ADMIN" +], +"enumDescriptions": [ +"Unspecified policy type.", +"Policy type denoting the system-configured policies.", +"Policy type denoting the admin-configurable policies." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"PolicyQuery": { +"description": "PolicyQuery", +"id": "PolicyQuery", +"properties": { +"group": { +"description": "Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string.", +"type": "string" +}, +"orgUnit": { +"description": "Required. Immutable. Non-empty default. The OrgUnit the query applies to. This field is only set if there is a single value for org_unit that satisfies all clauses of the query.", +"type": "string" +}, +"query": { +"description": "Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use.", +"type": "string" +}, +"sortOrder": { +"description": "Output only. The decimal sort order of this PolicyQuery. The value is relative to all other policies with the same setting type within the whole customer. (there are no duplicates within this set).", +"format": "double", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, "PosixGroup": { "description": "POSIX Group definition to represent a group in a POSIX compliant system. Caution: POSIX groups are deprecated. As of September 26, 2024, you can no longer create new POSIX groups. For more information, see https://cloud.google.com/identity/docs/deprecations/posix-groups", "id": "PosixGroup", @@ -5019,6 +5156,25 @@ "properties": {}, "type": "object" }, +"Setting": { +"description": "Setting", +"id": "Setting", +"properties": { +"type": { +"description": "Required. Immutable. The type of the Setting. .", +"type": "string" +}, +"value": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Required. The value of the Setting.", +"type": "object" +} +}, +"type": "object" +}, "SignInBehavior": { "description": "Controls sign-in behavior.", "id": "SignInBehavior", diff --git a/googleapiclient/discovery_cache/documents/cloudsearch.v1.json b/googleapiclient/discovery_cache/documents/cloudsearch.v1.json index a4e5c3f969..caedb8b160 100644 --- a/googleapiclient/discovery_cache/documents/cloudsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudsearch.v1.json @@ -2115,7 +2115,7 @@ } } }, -"revision": "20240612", +"revision": "20241016", "rootUrl": "https://cloudsearch.googleapis.com/", "schemas": { "Action": { @@ -7330,7 +7330,7 @@ false "type": "object" }, "SearchRequest": { -"description": "The search API request.", +"description": "The search API request. NEXT ID: 17", "id": "SearchRequest", "properties": { "contextAttributes": { @@ -7383,7 +7383,7 @@ false "type": "object" }, "SearchResponse": { -"description": "The search API response.", +"description": "The search API response. NEXT ID: 17", "id": "SearchResponse", "properties": { "debugInfo": { diff --git a/googleapiclient/discovery_cache/documents/composer.v1.json b/googleapiclient/discovery_cache/documents/composer.v1.json index 39e363a067..2bdaf12ad6 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1.json @@ -18,8 +18,93 @@ "endpoints": [ { "description": "Regional Endpoint", -"endpointUrl": "https://composer.us-south1.rep.googleapis.com/", -"location": "us-south1" +"endpointUrl": "https://composer.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-west2.rep.googleapis.com/", +"location": "europe-west2" }, { "description": "Regional Endpoint", @@ -28,6 +113,16 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://composer.europe-west8.rep.googleapis.com/", "location": "europe-west8" }, @@ -38,11 +133,56 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://composer.me-central2.rep.googleapis.com/", "location": "me-central2" }, { "description": "Regional Endpoint", +"endpointUrl": "https://composer.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://composer.us-central1.rep.googleapis.com/", "location": "us-central1" }, @@ -63,6 +203,16 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://composer.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://composer.us-west1.rep.googleapis.com/", "location": "us-west1" }, @@ -80,6 +230,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://composer.us-west4.rep.googleapis.com/", "location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.us-west8.rep.googleapis.com/", +"location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -1033,7 +1188,7 @@ } } }, -"revision": "20241007", +"revision": "20241013", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { diff --git a/googleapiclient/discovery_cache/documents/composer.v1beta1.json b/googleapiclient/discovery_cache/documents/composer.v1beta1.json index 8c686c3d85..fa7338aa3f 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1beta1.json @@ -18,8 +18,93 @@ "endpoints": [ { "description": "Regional Endpoint", -"endpointUrl": "https://composer.us-south1.rep.googleapis.com/", -"location": "us-south1" +"endpointUrl": "https://composer.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-west2.rep.googleapis.com/", +"location": "europe-west2" }, { "description": "Regional Endpoint", @@ -28,6 +113,16 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://composer.europe-west8.rep.googleapis.com/", "location": "europe-west8" }, @@ -38,11 +133,56 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://composer.me-central2.rep.googleapis.com/", "location": "me-central2" }, { "description": "Regional Endpoint", +"endpointUrl": "https://composer.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://composer.us-central1.rep.googleapis.com/", "location": "us-central1" }, @@ -63,6 +203,16 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://composer.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://composer.us-west1.rep.googleapis.com/", "location": "us-west1" }, @@ -80,6 +230,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://composer.us-west4.rep.googleapis.com/", "location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://composer.us-west8.rep.googleapis.com/", +"location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -1061,7 +1216,7 @@ } } }, -"revision": "20241007", +"revision": "20241013", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index b573bec6af..963febab98 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -2359,6 +2359,225 @@ } } }, +"crossSiteNetworks": { +"methods": { +"delete": { +"description": "Deletes the specified cross-site network in the given scope.", +"flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}", +"httpMethod": "DELETE", +"id": "compute.crossSiteNetworks.delete", +"parameterOrder": [ +"project", +"crossSiteNetwork" +], +"parameters": { +"crossSiteNetwork": { +"description": "Name of the cross-site network to delete.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Returns the specified cross-site network in the given scope.", +"flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}", +"httpMethod": "GET", +"id": "compute.crossSiteNetworks.get", +"parameterOrder": [ +"project", +"crossSiteNetwork" +], +"parameters": { +"crossSiteNetwork": { +"description": "Name of the cross-site network to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}", +"response": { +"$ref": "CrossSiteNetwork" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "Creates a cross-site network in the specified project in the given scope using the parameters that are included in the request.", +"flatPath": "projects/{project}/global/crossSiteNetworks", +"httpMethod": "POST", +"id": "compute.crossSiteNetworks.insert", +"parameterOrder": [ +"project" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "[Input Only] Validate the new configuration, but don't create it. If applicable, any configuration notices are returned in the `configurationNotices` field.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/global/crossSiteNetworks", +"request": { +"$ref": "CrossSiteNetwork" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "Lists the cross-site networks for a project in the given scope.", +"flatPath": "projects/{project}/global/crossSiteNetworks", +"httpMethod": "GET", +"id": "compute.crossSiteNetworks.list", +"parameterOrder": [ +"project" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/global/crossSiteNetworks", +"response": { +"$ref": "CrossSiteNetworkList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"patch": { +"description": "Updates the specified cross-site network with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", +"flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}", +"httpMethod": "PATCH", +"id": "compute.crossSiteNetworks.patch", +"parameterOrder": [ +"project", +"crossSiteNetwork" +], +"parameters": { +"crossSiteNetwork": { +"description": "Name of the cross-site network to update.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "[Input Only] Validate the new configuration, but don't update it. If applicable, any configuration notices are returned in the `configurationNotices` field.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}", +"request": { +"$ref": "CrossSiteNetwork" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, "diskSettings": { "methods": { "get": { @@ -2926,6 +3145,48 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getAsyncReplicationStatus": { +"description": "Gets the status of current async replication for a given device.", +"flatPath": "projects/{project}/zones/{zone}/disks/{disk}/getAsyncReplicationStatus", +"httpMethod": "GET", +"id": "compute.disks.getAsyncReplicationStatus", +"parameterOrder": [ +"project", +"zone", +"disk" +], +"parameters": { +"disk": { +"description": "Name of the Disk resource whose Async replication details are requested. Name should conform to RFC1035 or be an unsigned long integer.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/disks/{disk}/getAsyncReplicationStatus", +"response": { +"$ref": "GetAsyncReplicationStatusResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "getIamPolicy": { "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy", @@ -3525,6 +3786,55 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] +}, +"waitForReplicationCatchUp": { +"description": "Wait for replication to catch up on the secondary disk.", +"flatPath": "projects/{project}/zones/{zone}/disks/{disk}/waitForReplicationCatchUp", +"httpMethod": "POST", +"id": "compute.disks.waitForReplicationCatchUp", +"parameterOrder": [ +"project", +"zone", +"disk" +], +"parameters": { +"disk": { +"description": "The name of the persistent disk. Name should conform to RFC1035 or be an unsigned long integer.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/disks/{disk}/waitForReplicationCatchUp", +"request": { +"$ref": "WaitForReplicationCatchUpRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] } } }, @@ -22366,6 +22676,56 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"listPreconfiguredExpressionSets": { +"description": "Gets the current list of preconfigured Web Application Firewall (WAF) expressions.", +"flatPath": "locations/global/securityPolicies/listPreconfiguredExpressionSets", +"httpMethod": "GET", +"id": "compute.organizationSecurityPolicies.listPreconfiguredExpressionSets", +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"parentId": { +"description": "Parent ID for this request.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "locations/global/securityPolicies/listPreconfiguredExpressionSets", +"response": { +"$ref": "SecurityPoliciesListPreconfiguredExpressionSetsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "move": { "description": "Moves the specified security policy.", "flatPath": "locations/global/securityPolicies/{securityPolicy}/move", @@ -26016,6 +26376,48 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getAsyncReplicationStatus": { +"description": "Gets the status of current async replication for a given device.", +"flatPath": "projects/{project}/regions/{region}/disks/{disk}/getAsyncReplicationStatus", +"httpMethod": "GET", +"id": "compute.regionDisks.getAsyncReplicationStatus", +"parameterOrder": [ +"project", +"region", +"disk" +], +"parameters": { +"disk": { +"description": "Name of the Disk resource whose Async replication details are requested. Name should conform to RFC1035 or be an unsigned long integer.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/disks/{disk}/getAsyncReplicationStatus", +"response": { +"$ref": "GetAsyncReplicationStatusResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "getIamPolicy": { "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", "flatPath": "projects/{project}/regions/{region}/disks/{resource}/getIamPolicy", @@ -26615,6 +27017,55 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] +}, +"waitForReplicationCatchUp": { +"description": "Wait for replication to catch up on the secondary disk.", +"flatPath": "projects/{project}/regions/{region}/disks/{disk}/waitForReplicationCatchUp", +"httpMethod": "POST", +"id": "compute.regionDisks.waitForReplicationCatchUp", +"parameterOrder": [ +"project", +"region", +"disk" +], +"parameters": { +"disk": { +"description": "The name of the persistent disk. Name should conform to RFC1035 or be an unsigned long integer.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/disks/{disk}/waitForReplicationCatchUp", +"request": { +"$ref": "RegionWaitForReplicationCatchUpRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] } } }, @@ -30279,7 +30730,7 @@ ] }, "get": { -"description": "Returns the specified multi-MIG resource.", +"description": "Returns all the details of a specific multi-MIG.", "flatPath": "projects/{project}/regions/{region}/multiMigs/{multiMig}", "httpMethod": "GET", "id": "compute.regionMultiMigs.get", @@ -30346,7 +30797,7 @@ "type": "string" }, "requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents you from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -45871,21 +46322,20 @@ } } }, -"zoneOperations": { +"wireGroups": { "methods": { "delete": { -"description": "Deletes the specified zone-specific Operations resource.", -"flatPath": "projects/{project}/zones/{zone}/operations/{operation}", +"description": "Deletes the specified wire group in the given scope.", +"flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}", "httpMethod": "DELETE", -"id": "compute.zoneOperations.delete", +"id": "compute.wireGroups.delete", "parameterOrder": [ "project", -"zone", -"operation" +"crossSiteNetwork", +"wireGroup" ], "parameters": { -"operation": { -"description": "Name of the Operations resource to delete, or its unique numeric identifier.", +"crossSiteNetwork": { "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -45898,94 +46348,43 @@ "required": true, "type": "string" }, -"zone": { -"description": "Name of the zone for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", +"location": "query", "type": "string" -} }, -"path": "projects/{project}/zones/{zone}/operations/{operation}", -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, -"get": { -"description": "Retrieves the specified zone-specific Operations resource.", -"flatPath": "projects/{project}/zones/{zone}/operations/{operation}", -"httpMethod": "GET", -"id": "compute.zoneOperations.get", -"parameterOrder": [ -"project", -"zone", -"operation" -], -"parameters": { -"operation": { -"description": "Name of the Operations resource to return, or its unique numeric identifier.", +"wireGroup": { +"description": "Name of the wire group resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"zone": { -"description": "Name of the zone for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" } }, -"path": "projects/{project}/zones/{zone}/operations/{operation}", +"path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, -"list": { -"description": "Retrieves a list of Operation resources contained within the specified zone.", -"flatPath": "projects/{project}/zones/{zone}/operations", +"get": { +"description": "Gets the specified wire group resource in the given scope.", +"flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}", "httpMethod": "GET", -"id": "compute.zoneOperations.list", +"id": "compute.wireGroups.get", "parameterOrder": [ "project", -"zone" +"crossSiteNetwork", +"wireGroup" ], "parameters": { -"filter": { -"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", -"location": "query", -"type": "string" -}, -"maxResults": { -"default": "500", -"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", -"format": "uint32", -"location": "query", -"minimum": "0", -"type": "integer" -}, -"orderBy": { -"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", -"location": "query", -"type": "string" -}, -"pageToken": { -"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", -"location": "query", +"crossSiteNetwork": { +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, "type": "string" }, "project": { @@ -45995,22 +46394,17 @@ "required": true, "type": "string" }, -"returnPartialSuccess": { -"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", -"location": "query", -"type": "boolean" -}, -"zone": { -"description": "Name of the zone for request.", +"wireGroup": { +"description": "Name of the wire group resource to return.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/zones/{zone}/operations", +"path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}", "response": { -"$ref": "OperationList" +"$ref": "WireGroup" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -46018,19 +46412,17 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"wait": { -"description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ", -"flatPath": "projects/{project}/zones/{zone}/operations/{operation}/wait", +"insert": { +"description": "Creates a wire group in the specified project in the given scope using the parameters that are included in the request.", +"flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups", "httpMethod": "POST", -"id": "compute.zoneOperations.wait", +"id": "compute.wireGroups.insert", "parameterOrder": [ "project", -"zone", -"operation" +"crossSiteNetwork" ], "parameters": { -"operation": { -"description": "Name of the Operations resource to return, or its unique numeric identifier.", +"crossSiteNetwork": { "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -46043,47 +46435,366 @@ "required": true, "type": "string" }, -"zone": { -"description": "Name of the zone for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", +"location": "query", "type": "string" +}, +"validateOnly": { +"description": "[Input Only] Validate the new configuration, but don't create it. If applicable, any configuration notices are returned in the `configurationNotices` field.", +"location": "query", +"type": "boolean" } }, -"path": "projects/{project}/zones/{zone}/operations/{operation}/wait", +"path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups", +"request": { +"$ref": "WireGroup" +}, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] -} -} }, -"zoneQueuedResources": { -"methods": { -"aggregatedList": { -"description": "Retrieves an aggregated list of all of the queued resources in a project across all zones. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", -"flatPath": "projects/{project}/aggregated/queuedResources", +"list": { +"description": "Lists the wire groups for a project in the given scope.", +"flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups", "httpMethod": "GET", -"id": "compute.zoneQueuedResources.aggregatedList", +"id": "compute.wireGroups.list", "parameterOrder": [ -"project" +"project", +"crossSiteNetwork" ], "parameters": { +"crossSiteNetwork": { +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, -"includeAllScopes": { -"description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", -"location": "query", -"type": "boolean" -}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups", +"response": { +"$ref": "WireGroupList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"patch": { +"description": "Updates the specified wire group resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", +"flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}", +"httpMethod": "PATCH", +"id": "compute.wireGroups.patch", +"parameterOrder": [ +"project", +"crossSiteNetwork", +"wireGroup" +], +"parameters": { +"crossSiteNetwork": { +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "update_mask indicates fields to be updated as part of this request.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "[Input Only] Validate the new configuration, but don't update it. If applicable, any configuration notices are returned in the `configurationNotices` field.", +"location": "query", +"type": "boolean" +}, +"wireGroup": { +"description": "Name of the WireGroups resource to patch.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}", +"request": { +"$ref": "WireGroup" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, +"zoneOperations": { +"methods": { +"delete": { +"description": "Deletes the specified zone-specific Operations resource.", +"flatPath": "projects/{project}/zones/{zone}/operations/{operation}", +"httpMethod": "DELETE", +"id": "compute.zoneOperations.delete", +"parameterOrder": [ +"project", +"zone", +"operation" +], +"parameters": { +"operation": { +"description": "Name of the Operations resource to delete, or its unique numeric identifier.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/operations/{operation}", +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Retrieves the specified zone-specific Operations resource.", +"flatPath": "projects/{project}/zones/{zone}/operations/{operation}", +"httpMethod": "GET", +"id": "compute.zoneOperations.get", +"parameterOrder": [ +"project", +"zone", +"operation" +], +"parameters": { +"operation": { +"description": "Name of the Operations resource to return, or its unique numeric identifier.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/operations/{operation}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"list": { +"description": "Retrieves a list of Operation resources contained within the specified zone.", +"flatPath": "projects/{project}/zones/{zone}/operations", +"httpMethod": "GET", +"id": "compute.zoneOperations.list", +"parameterOrder": [ +"project", +"zone" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +}, +"zone": { +"description": "Name of the zone for request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/operations", +"response": { +"$ref": "OperationList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"wait": { +"description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ", +"flatPath": "projects/{project}/zones/{zone}/operations/{operation}/wait", +"httpMethod": "POST", +"id": "compute.zoneOperations.wait", +"parameterOrder": [ +"project", +"zone", +"operation" +], +"parameters": { +"operation": { +"description": "Name of the Operations resource to return, or its unique numeric identifier.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/operations/{operation}/wait", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, +"zoneQueuedResources": { +"methods": { +"aggregatedList": { +"description": "Retrieves an aggregated list of all of the queued resources in a project across all zones. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", +"flatPath": "projects/{project}/aggregated/queuedResources", +"httpMethod": "GET", +"id": "compute.zoneQueuedResources.aggregatedList", +"parameterOrder": [ +"project" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"includeAllScopes": { +"description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", +"location": "query", +"type": "boolean" +}, "maxResults": { "default": "500", "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", @@ -46468,7 +47179,7 @@ } } }, -"revision": "20241001", +"revision": "20241015", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -47885,13 +48596,13 @@ false "id": "AllocationResourceStatus", "properties": { "reservationBlockCount": { -"description": "Indicates number of blocks for accelerator optimized family (applicable beyond A3 only).", +"description": "The number of reservation blocks associated with this reservation.", "format": "int32", "type": "integer" }, "reservationMaintenance": { "$ref": "GroupMaintenanceInfo", -"description": "Maintenance information for the group of hosts on this reservation including running VMs and unused hosts. Applicable only to accelerator optimized VM families beyond A3 only. For both DENSE or STANDARD reservation, granular maintenance information can be retried at reservation block level." +"description": "Maintenance information for this reservation" }, "specificSkuAllocation": { "$ref": "AllocationResourceStatusSpecificSKUAllocation", @@ -48026,6 +48737,18 @@ false }, "type": "object" }, +"AsyncReplicationStatus": { +"id": "AsyncReplicationStatus", +"properties": { +"diskPairReplicationState": { +"$ref": "DiskPairReplicationState" +}, +"lastReplicationDetails": { +"$ref": "ReplicationDetails" +} +}, +"type": "object" +}, "AttachedDisk": { "description": "An instance-attached disk resource.", "id": "AttachedDisk", @@ -48329,7 +49052,7 @@ false "type": "object" }, "AuditConfig": { -"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.", +"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "AuditConfig", "properties": { "auditLogConfigs": { @@ -51733,10 +52456,6 @@ false "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", "properties": { -"bindingId": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -}, "condition": { "$ref": "Expr", "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." @@ -52217,6 +52936,7 @@ false "ACCELERATOR_OPTIMIZED", "ACCELERATOR_OPTIMIZED_A3", "ACCELERATOR_OPTIMIZED_A3_MEGA", +"ACCELERATOR_OPTIMIZED_A3_ULTRA", "COMPUTE_OPTIMIZED", "COMPUTE_OPTIMIZED_C2D", "COMPUTE_OPTIMIZED_C3", @@ -52263,6 +52983,7 @@ false "", "", "", +"", "" ], "type": "string" @@ -52756,86 +53477,6 @@ false }, "type": "object" }, -"Condition": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "Condition", -"properties": { -"iam": { -"description": "This is deprecated and has no effect. Do not use.", -"enum": [ -"APPROVER", -"ATTRIBUTION", -"AUTHORITY", -"CREDENTIALS_TYPE", -"CREDS_ASSERTION", -"JUSTIFICATION_TYPE", -"NO_ATTR", -"SECURITY_REALM" -], -"enumDescriptions": [ -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use." -], -"type": "string" -}, -"op": { -"description": "This is deprecated and has no effect. Do not use.", -"enum": [ -"DISCHARGED", -"EQUALS", -"IN", -"NOT_EQUALS", -"NOT_IN", -"NO_OP" -], -"enumDescriptions": [ -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use." -], -"type": "string" -}, -"svc": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -}, -"sys": { -"description": "This is deprecated and has no effect. Do not use.", -"enum": [ -"IP", -"NAME", -"NO_ATTR", -"REGION", -"SERVICE" -], -"enumDescriptions": [ -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use." -], -"type": "string" -}, -"values": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "ConfidentialInstanceConfig": { "description": "A set of Confidential Instance options.", "id": "ConfidentialInstanceConfig", @@ -52969,6 +53610,206 @@ false }, "type": "object" }, +"CrossSiteNetwork": { +"description": "A resource that represents a cross-site network. You can use cross-site networks to connect your on-premises networks to each other through Interconnect connections.", +"id": "CrossSiteNetwork", +"properties": { +"creationTimestamp": { +"description": "[Output Only] Creation timestamp in RFC3339 text format.", +"type": "string" +}, +"description": { +"description": "An optional description of the cross-site network.", +"type": "string" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", +"format": "uint64", +"type": "string" +}, +"kind": { +"default": "compute#crossSiteNetwork", +"description": "[Output Only] Type of the resource. Always compute#crossSiteNetwork for cross-site networks.", +"type": "string" +}, +"name": { +"description": "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.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for the resource.", +"type": "string" +}, +"selfLinkWithId": { +"description": "[Output Only] Server-defined URL for this resource with the resource id.", +"type": "string" +} +}, +"type": "object" +}, +"CrossSiteNetworkList": { +"description": "Response to the list request that contains a list of cross-site networks.", +"id": "CrossSiteNetworkList", +"properties": { +"etag": { +"type": "string" +}, +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of CrossSiteNetwork resources.", +"items": { +"$ref": "CrossSiteNetwork" +}, +"type": "array" +}, +"kind": { +"default": "compute#crossSiteNetwork", +"description": "[Output Only] Type of the resource. Always compute#crossSiteNetwork for cross-site networks.", +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", +"type": "string" +}, +"unreachables": { +"description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", +"items": { +"type": "string" +}, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "CustomErrorResponsePolicy": { "description": "Specifies the custom error response policy that must be applied when the backend service or backend bucket responds with an error.", "id": "CustomErrorResponsePolicy", @@ -53822,6 +54663,39 @@ false }, "type": "object" }, +"DiskPairReplicationState": { +"id": "DiskPairReplicationState", +"properties": { +"dataReplicationState": { +"description": "[Output Only] The status of disk creation. - ASYNC_REPLICATION_STATE_INITIALIZING: The device is doing the initial replication after starting the replication. - ASYNC_REPLICATION_STATE_REPLICATING_HEALTHY: The primary disk is healthily replicating to the secondary device i.e. last_replication_time is within RPO. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND: The replication is lagging above the SLO limit due to some internal issue. - ASYNC_REPLICATION_STATE_REPLICATING_UNHEALTHY: The replication is lagging, and the RPO is not being met due to some internal issue. . - ASYNC_REPLICATION_STATE_REPLICATION_STUCK: The replication is completely stuck due to some internal error. - ASYNC_REPLICATION_STATE_STOPPING: The replication is under the process of being stopped. This is a transient state. - ASYNC_REPLICATION_STATE_STOPPED: The replication between the disk-pairs have stopped. ", +"enum": [ +"ASYNC_REPLICATION_STATE_INITIALIZING", +"ASYNC_REPLICATION_STATE_REPLICATING_BEHIND", +"ASYNC_REPLICATION_STATE_REPLICATING_HEALTHY", +"ASYNC_REPLICATION_STATE_REPLICATING_UNHEALTHY", +"ASYNC_REPLICATION_STATE_REPLICATION_STUCK", +"ASYNC_REPLICATION_STATE_STOPPED", +"ASYNC_REPLICATION_STATE_STOPPING", +"ASYNC_REPLICATION_STATE_UNSPECIFIED" +], +"enumDescriptions": [ +"The device is doing the initial replication after starting the replication.", +"The replication is lagging behind (last_replication_time > RPO), because the disk's change rate is above the supported limit.", +"The primary disk is healthily replicating to the secondary device i.e. last_replication_time is within RPO.", +"The replication is lagging, and the RPO is not being met due to some internal issue.", +"The replication is completely stuck due to some internal error.", +"The replication between the disk-pairs have stopped.", +"The replication is under the process of being stopped. This is a transient sate.", +"" +], +"type": "string" +}, +"replicationDiskPair": { +"$ref": "ReplicationDiskPair" +} +}, +"type": "object" +}, "DiskParams": { "description": "Additional disk params.", "id": "DiskParams", @@ -56905,9 +57779,9 @@ false "FLEXIBLE" ], "enumDescriptions": [ -"Number of deployment blocks, size, and topology is fixed during creation and does not change over time. Deployment will be expressed in terms of blocks.", -"Deployment type is unspecified.", -"Distribution of capacity in blocks is not static and can change over time. This is expected to have more obtainability over DENSE deployment. Deployment will not be expressed in terms of blocks." +"The reserved capacity is made up of densely deployed reservation blocks.", +"", +"The reserved capacity is made up of highly flexible, logical reservation blocks." ], "type": "string" }, @@ -56976,16 +57850,16 @@ false "type": "string" }, "schedulingType": { -"description": "Indicates the maintenance type for this group of VMs. This will be set on the reservation via FR, and will be inherited for reservation blocks.", +"description": "Maintenance information for this reservation", "enum": [ "GROUPED", "GROUP_MAINTENANCE_TYPE_UNSPECIFIED", "INDEPENDENT" ], "enumDescriptions": [ -"Synchronized maintenance. Common maintenance schedule/window is defined for this group of VMs. Not applicable for FLEXIBLE reservation", +"Maintenance on all reserved instances in the reservation is synchronized.", "Unknown maintenance type.", -"Unsynchronized maintenance. These group of VMs do not share a common schedule for maintenance. Instead all VMs have individual windows of their own in which maintenance is scheduled." +"Maintenance is not synchronized for this reservation. Instead, each instance has its own maintenance window." ], "type": "string" }, @@ -57805,6 +58679,19 @@ false }, "type": "object" }, +"GetAsyncReplicationStatusResponse": { +"id": "GetAsyncReplicationStatusResponse", +"properties": { +"asyncReplicationStatus": { +"$ref": "AsyncReplicationStatus" +}, +"etag": { +"description": "end_interface: MixerGetResponseWithEtagBuilder", +"type": "string" +} +}, +"type": "object" +}, "GetOwnerInstanceResponse": { "id": "GetOwnerInstanceResponse", "properties": { @@ -57922,7 +58809,7 @@ false "id": "GroupMaintenanceInfo", "properties": { "enableOpportunisticMaintenance": { -"description": "Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the reservation, and will be inherited for reservation blocks.", +"description": "This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible.", "type": "boolean" }, "maintenanceOngoingCount": { @@ -57936,16 +58823,16 @@ false "type": "integer" }, "schedulingType": { -"description": "Indicates the maintenance type for this group of VMs. This will be set on the reservation, and will be inherited for reservation blocks.", +"description": "The type of maintenance for the reservation.", "enum": [ "GROUPED", "GROUP_MAINTENANCE_TYPE_UNSPECIFIED", "INDEPENDENT" ], "enumDescriptions": [ -"Synchronized maintenance. Common maintenance schedule/window is defined for this group of VMs. Not applicable for FLEXIBLE reservation", +"Maintenance on all reserved instances in the reservation is synchronized.", "Unknown maintenance type.", -"Unsynchronized maintenance. These group of VMs do not share a common schedule for maintenance. Instead all VMs have individual windows of their own in which maintenance is scheduled." +"Maintenance is not synchronized for this reservation. Instead, each instance has its own maintenance window." ], "type": "string" }, @@ -61895,7 +62782,7 @@ false "type": "string" }, "namedPorts": { -"description": "Named ports configured for the Instance Groups complementary to this Instance Group Manager.", +"description": "[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.", "items": { "$ref": "NamedPort" }, @@ -65476,7 +66363,7 @@ false "id": "InstancesGetEffectiveFirewallsResponse", "properties": { "firewallPolicys": { -"description": "Effective firewalls from firewall policies.", +"description": "[Output Only] Effective firewalls from firewall policies.", "items": { "$ref": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" }, @@ -65517,7 +66404,7 @@ false "type": "integer" }, "rules": { -"description": "The rules that apply to the network.", +"description": "[Output Only] The rules that apply to the instance. Only rules that target the specific VM instance are returned if target service accounts or target secure tags are specified in the rules.", "items": { "$ref": "FirewallPolicyRule" }, @@ -66603,7 +67490,7 @@ false "id": "Interconnect", "properties": { "aaiEnabled": { -"description": "Enable or disable the Application Aware Interconnect(AAI) feature on this interconnect.", +"description": "Enable or disable the application awareness feature on this Cloud Interconnect.", "type": "boolean" }, "adminEnabled": { @@ -66612,7 +67499,7 @@ false }, "applicationAwareInterconnect": { "$ref": "InterconnectApplicationAwareInterconnect", -"description": "Configuration for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router." +"description": "Configuration information for application awareness on this Cloud Interconnect." }, "availableFeatures": { "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails.", @@ -66820,14 +67707,14 @@ false "type": "object" }, "InterconnectApplicationAwareInterconnect": { -"description": "Configuration information for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router.", +"description": "Configuration information for application awareness on this Cloud Interconnect.", "id": "InterconnectApplicationAwareInterconnect", "properties": { "bandwidthPercentagePolicy": { "$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy" }, "profileDescription": { -"description": "A description for the AAI profile on this interconnect.", +"description": "Description for the application awareness profile on this Cloud Interconnect.", "type": "string" }, "shapeAveragePercentages": { @@ -70843,102 +71730,6 @@ false }, "type": "object" }, -"LogConfig": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "LogConfig", -"properties": { -"cloudAudit": { -"$ref": "LogConfigCloudAuditOptions", -"description": "This is deprecated and has no effect. Do not use." -}, -"counter": { -"$ref": "LogConfigCounterOptions", -"description": "This is deprecated and has no effect. Do not use." -}, -"dataAccess": { -"$ref": "LogConfigDataAccessOptions", -"description": "This is deprecated and has no effect. Do not use." -} -}, -"type": "object" -}, -"LogConfigCloudAuditOptions": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "LogConfigCloudAuditOptions", -"properties": { -"logName": { -"description": "This is deprecated and has no effect. Do not use.", -"enum": [ -"ADMIN_ACTIVITY", -"DATA_ACCESS", -"UNSPECIFIED_LOG_NAME" -], -"enumDescriptions": [ -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use." -], -"type": "string" -} -}, -"type": "object" -}, -"LogConfigCounterOptions": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "LogConfigCounterOptions", -"properties": { -"customFields": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"$ref": "LogConfigCounterOptionsCustomField" -}, -"type": "array" -}, -"field": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -}, -"metric": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -} -}, -"type": "object" -}, -"LogConfigCounterOptionsCustomField": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "LogConfigCounterOptionsCustomField", -"properties": { -"name": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -}, -"value": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -} -}, -"type": "object" -}, -"LogConfigDataAccessOptions": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "LogConfigDataAccessOptions", -"properties": { -"logMode": { -"description": "This is deprecated and has no effect. Do not use.", -"enum": [ -"LOG_FAIL_CLOSED", -"LOG_MODE_UNSPECIFIED" -], -"enumDescriptions": [ -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use." -], -"type": "string" -} -}, -"type": "object" -}, "MachineImage": { "description": "Represents a machine image resource. A machine image is a Compute Engine resource that stores all the configuration, metadata, permissions, and data from one or more disks required to create a Virtual machine (VM) instance. For more information, see Machine images.", "id": "MachineImage", @@ -72340,11 +73131,11 @@ false "type": "object" }, "MultiMigResourcePolicies": { -"description": "Resource policies message for a multi-MIG. Represents low level machine cluster behavior in several dimensions, all of which depend on the machine family and fleet.", +"description": "Resource policies message for a multi-MIG. Specifies the workload policy configuration of the multi-MIG.", "id": "MultiMigResourcePolicies", "properties": { "workloadPolicy": { -"description": "The URL of the workload policy that is specified for this multi-MIG. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy ", +"description": "The URL of the workload policy for this multi-MIG. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy ", "type": "string" } }, @@ -72392,7 +73183,7 @@ false "type": "string" }, "items": { -"description": "A list of multi-MIG resources.", +"description": "A list of multi-MIGs in the specified project and region.", "items": { "$ref": "MultiMig" }, @@ -75427,7 +76218,26 @@ false ], "type": "string" }, -"allowedSubnetPurposes": { +"interfaceTypes": { +"description": "If set, limits the interface types that the network supports. If empty, all interface types are supported.", +"items": { +"enum": [ +"GVNIC", +"IDPF", +"UNSPECIFIED_NIC_TYPE", +"VIRTIO_NET" +], +"enumDescriptions": [ +"GVNIC", +"IDPF", +"No type specified.", +"VIRTIO" +], +"type": "string" +}, +"type": "array" +}, +"subnetPurposes": { "description": "Specifies which subnetwork purposes are supported.", "items": { "enum": [ @@ -75442,7 +76252,7 @@ false }, "type": "array" }, -"allowedSubnetStackTypes": { +"subnetStackTypes": { "description": "Specifies which subnetwork stack types are supported.", "items": { "enum": [ @@ -75459,25 +76269,6 @@ false }, "type": "array" }, -"interfaceTypes": { -"description": "If set, limits the interface types that the network supports. If empty, all interface types are supported.", -"items": { -"enum": [ -"GVNIC", -"IDPF", -"UNSPECIFIED_NIC_TYPE", -"VIRTIO_NET" -], -"enumDescriptions": [ -"GVNIC", -"IDPF", -"No type specified.", -"VIRTIO" -], -"type": "string" -}, -"type": "array" -}, "unicast": { "description": "Specifies which type of unicast is supported.", "enum": [ @@ -75741,7 +76532,7 @@ false "id": "NetworksGetEffectiveFirewallsResponse", "properties": { "firewallPolicys": { -"description": "Effective firewalls from firewall policy.", +"description": "[Output Only] Effective firewalls from firewall policy. It returns Global Network Firewall Policies and Hierarchical Firewall Policies. Use regionNetworkFirewallPolicies.getEffectiveFirewalls to get Regional Network Firewall Policies as well.", "items": { "$ref": "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy" }, @@ -75782,7 +76573,7 @@ false "type": "integer" }, "rules": { -"description": "The rules that apply to the network.", +"description": "[Output Only] The rules that apply to the network.", "items": { "$ref": "FirewallPolicyRule" }, @@ -80155,13 +80946,6 @@ false "format": "byte", "type": "string" }, -"rules": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"$ref": "Rule" -}, -"type": "array" -}, "version": { "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", @@ -84486,7 +85270,7 @@ false "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse", "properties": { "firewallPolicys": { -"description": "Effective firewalls from firewall policy.", +"description": "[Output only] Effective firewalls from firewall policy. It applies to Regional Network Firewall Policies in the specified region, Global Network Firewall Policies and Hierachial Firewall Policies which are associated with the network.", "items": { "$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" }, @@ -84519,7 +85303,7 @@ false "type": "integer" }, "rules": { -"description": "The rules that apply to the network.", +"description": "[Output only] The rules that apply to the network.", "items": { "$ref": "FirewallPolicyRule" }, @@ -84611,6 +85395,46 @@ false }, "type": "object" }, +"RegionWaitForReplicationCatchUpRequest": { +"id": "RegionWaitForReplicationCatchUpRequest", +"properties": { +"maxWaitDuration": { +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"ReplicationDetails": { +"id": "ReplicationDetails", +"properties": { +"lastReplicationTime": { +"description": "The last sync time of the device pair.", +"format": "google-datetime", +"type": "string" +}, +"secondsSinceLastReplication": { +"description": "Replication lag in seconds. This will only be populated if device is in replicating state. Note that the value is calculated sometime during request processing and at the instant the client receives the response, the current replication_lag may have changed.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"ReplicationDiskPair": { +"id": "ReplicationDiskPair", +"properties": { +"primaryDisk": { +"description": "URL of the primary disk.", +"type": "string" +}, +"secondaryDisk": { +"description": "URL of the secondary disk.", +"type": "string" +} +}, +"type": "object" +}, "RequestMirrorPolicy": { "description": "A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow.", "id": "RequestMirrorPolicy", @@ -84659,9 +85483,9 @@ false "FLEXIBLE" ], "enumDescriptions": [ -"Number of deployment blocks, size, and topology is fixed during creation and does not change over time. Deployment will be expressed in terms of blocks.", -"Deployment type is unspecified.", -"Distribution of capacity in blocks is not static and can change over time. This is expected to have more obtainability over DENSE deployment. Deployment will not be expressed in terms of blocks." +"The reserved capacity is made up of densely deployed reservation blocks.", +"", +"The reserved capacity is made up of highly flexible, logical reservation blocks." ], "type": "string" }, @@ -84675,7 +85499,7 @@ false "type": "string" }, "instanceTerminationAction": { -"description": "Instance termination action that will be invoked when the reservation is deleted.", +"description": "Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type.", "enum": [ "DELETE", "INSTANCE_TERMINATION_ACTION_UNSPECIFIED", @@ -84743,7 +85567,7 @@ false "type": "boolean" }, "status": { -"description": "[Output Only] The status of the reservation.", +"description": "[Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. ", "enum": [ "CREATING", "DELETING", @@ -84752,11 +85576,11 @@ false "UPDATING" ], "enumDescriptions": [ -"Resources are being allocated for the reservation.", -"Reservation is currently being deleted.", +"Reservation resources are being allocated.", +"Reservation deletion is in progress.", "", -"Reservation has allocated all its resources.", -"Reservation is currently being resized." +"Reservation resources have been allocated, and the reservation is ready for use.", +"Reservation update is in progress." ], "type": "string" }, @@ -84970,7 +85794,7 @@ false "id": "ReservationBlock", "properties": { "count": { -"description": "[Output Only] Specifies the number of resources that are allocated in this block. It indicates the maximum number of VMs that a user can run on this particular block.", +"description": "[Output Only] The number of resources that are allocated in this reservation block.", "format": "int32", "type": "integer" }, @@ -84984,7 +85808,7 @@ false "type": "string" }, "inUseCount": { -"description": "[Output Only] Indicates how many instances are in use on this block.", +"description": "[Output Only] The number of instances that are currently in use on this reservation block.", "format": "int32", "type": "integer" }, @@ -84994,6 +85818,7 @@ false "type": "string" }, "locationPrefix": { +"deprecated": true, "description": "[Output Only] Obfuscated location where this reservation block physically resides in format /CCCC/GGGG. This matches the tripod specified in the VM topology information. Example: /USEAB1/0101/ is the location prefix in /USEAB1/0101/031/003", "type": "string" }, @@ -85001,9 +85826,13 @@ false "description": "[Output Only] The name of this reservation block generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, +"physicalTopology": { +"$ref": "ReservationBlockPhysicalTopology", +"description": "[Output Only] The physical topology of the reservation block." +}, "reservationMaintenance": { "$ref": "GroupMaintenanceInfo", -"description": "[Output Only] Maintenance information for the group of hosts on this reservation including running VMs and unused hosts. Applicable only to accelerator optimized VM families beyond A3 only. For both DENSE or STANDARD reservation, granular maintenance information can be retried at reservation block level." +"description": "[Output Only] Maintenance information for this reservation block." }, "selfLink": { "description": "[Output Only] Server-defined fully-qualified URL for this resource.", @@ -85036,6 +85865,20 @@ false }, "type": "object" }, +"ReservationBlockPhysicalTopology": { +"id": "ReservationBlockPhysicalTopology", +"properties": { +"block": { +"description": "The hash of the capacity block within the cluster.", +"type": "string" +}, +"cluster": { +"description": "The cluster name of the reservation block.", +"type": "string" +} +}, +"type": "object" +}, "ReservationBlocksGetResponse": { "id": "ReservationBlocksGetResponse", "properties": { @@ -86473,6 +87316,10 @@ false "description": "[Output Only] An opaque ID of the host on which the VM is running.", "type": "string" }, +"physicalHostTopology": { +"$ref": "ResourceStatusPhysicalHostTopology", +"description": "[Output Only] The physical host topology of the host on which the VM is running." +}, "scheduling": { "$ref": "ResourceStatusScheduling" }, @@ -86599,6 +87446,25 @@ false }, "type": "object" }, +"ResourceStatusPhysicalHostTopology": { +"description": "Represents the physical host topology of the host on which the VM is running.", +"id": "ResourceStatusPhysicalHostTopology", +"properties": { +"block": { +"type": "string" +}, +"cluster": { +"type": "string" +}, +"host": { +"type": "string" +}, +"subblock": { +"type": "string" +} +}, +"type": "object" +}, "ResourceStatusScheduling": { "id": "ResourceStatusScheduling", "properties": { @@ -89305,72 +90171,6 @@ false }, "type": "object" }, -"Rule": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "Rule", -"properties": { -"action": { -"description": "This is deprecated and has no effect. Do not use.", -"enum": [ -"ALLOW", -"ALLOW_WITH_LOG", -"DENY", -"DENY_WITH_LOG", -"LOG", -"NO_ACTION" -], -"enumDescriptions": [ -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use." -], -"type": "string" -}, -"conditions": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"$ref": "Condition" -}, -"type": "array" -}, -"description": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -}, -"ins": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"type": "string" -}, -"type": "array" -}, -"logConfigs": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"$ref": "LogConfig" -}, -"type": "array" -}, -"notIns": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"type": "string" -}, -"type": "array" -}, -"permissions": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "SSLHealthCheck": { "id": "SSLHealthCheck", "properties": { @@ -89735,6 +90535,10 @@ false ], "type": "string" }, +"shutdownTimeout": { +"$ref": "Duration", +"description": "Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs." +}, "terminationTime": { "description": "Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time.", "type": "string" @@ -103936,6 +104740,16 @@ false }, "type": "object" }, +"WaitForReplicationCatchUpRequest": { +"id": "WaitForReplicationCatchUpRequest", +"properties": { +"maxWaitDuration": { +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, "WeightedBackendService": { "description": "In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple backend services. The volume of traffic for each backend service is proportional to the weight specified in each WeightedBackendService", "id": "WeightedBackendService", @@ -103956,6 +104770,425 @@ false }, "type": "object" }, +"Wire": { +"description": "A pseudowire that connects two Interconnect connections.", +"id": "Wire", +"properties": { +"adminEnabled": { +"description": "[Output Only] Indicates whether the wire is enabled. When false, the wire is disabled. When true and when the wire group of the wire is also enabled, the wire is enabled. Defaults to true.", +"type": "boolean" +}, +"endpoints": { +"description": "Wire endpoints are specific Interconnect connections.", +"items": { +"$ref": "WireEndpoint" +}, +"type": "array" +}, +"label": { +"description": "[Output Only] A label that identifies the wire. The format of this label combines the existing labels of the wire group endpoints and Interconnect connections used by this wire in alphabetical order as follows: `ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1`, where: - ENDPOINT_A and ENDPOINT_B: are the labels that you entered as map keys when you specified the wire group endpoint objects. - CONNECTION_A1 and CONNECTION_B1: are the labels that you entered as map keys when you specified the wire group Interconnect objects. ", +"type": "string" +}, +"wireProperties": { +"$ref": "WireProperties", +"description": "[Output Only] Properties of the wire." +} +}, +"type": "object" +}, +"WireEndpoint": { +"description": "Wire endpoints are specific Interconnect connections.", +"id": "WireEndpoint", +"properties": { +"interconnect": { +"type": "string" +}, +"vlanTag": { +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"WireGroup": { +"description": "A resource that represents a group of redundant wires.", +"id": "WireGroup", +"properties": { +"adminEnabled": { +"description": "Indicates whether the wires in the wire group are enabled. When false, the wires in the wire group are disabled. When true and when there is simultaneously no wire-specific override of `adminEnabled` to false, a given wire is enabled. Defaults to true.", +"type": "boolean" +}, +"creationTimestamp": { +"description": "[Output Only] Creation timestamp in RFC3339 text format.", +"type": "string" +}, +"description": { +"description": "An optional description of the wire group.", +"type": "string" +}, +"endpoints": { +"additionalProperties": { +"$ref": "WireGroupEndpoint" +}, +"description": "A map that contains the logical endpoints of the wire group. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Endpoint object. ", +"type": "object" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", +"format": "uint64", +"type": "string" +}, +"kind": { +"default": "compute#wireGroup", +"description": "[Output Only] Type of the resource. Always compute#wireGroups for wire groups.", +"type": "string" +}, +"name": { +"description": "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.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for the resource.", +"type": "string" +}, +"selfLinkWithId": { +"type": "string" +}, +"serviceLevel": { +"$ref": "WireGroupServiceLevel", +"description": "Service level details determined for the wire group configuration." +}, +"wireGroupProperties": { +"$ref": "WireGroupProperties", +"description": "Properties of the wire group." +}, +"wireInputs": { +"additionalProperties": { +"$ref": "WireGroupWireInputs" +}, +"description": "A map that contains optional settings for individual wires. Specify key-value pairs for the map as follows: - Key: the label of an existing wire. To view a wire label and its format, see the wires[].label field. - Value: a WireInputs object. ", +"type": "object" +}, +"wireProperties": { +"$ref": "WireProperties", +"description": "Properties for all wires in the wire group." +}, +"wires": { +"description": "The single/redundant wire(s) managed by the wire group.", +"items": { +"$ref": "Wire" +}, +"type": "array" +} +}, +"type": "object" +}, +"WireGroupEndpoint": { +"description": "A logical endpoint for the wire group. An endpoint represents a metro that contains redundant Interconnect connections. A wire group is created between two endpoints.", +"id": "WireGroupEndpoint", +"properties": { +"interconnects": { +"additionalProperties": { +"$ref": "WireGroupEndpointInterconnect" +}, +"description": "A map that contains the redundant Interconnect connections. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Interconnect object. ", +"type": "object" +} +}, +"type": "object" +}, +"WireGroupEndpointInterconnect": { +"description": "The redundant Interconnect connections for this endpoint.", +"id": "WireGroupEndpointInterconnect", +"properties": { +"interconnect": { +"description": "An Interconnect connection. You can specify the connection as a partial or full URL. If the connection is in a different project from the cross-site network, use a format that specifies the project. See the following examples of partial and full URLs: global/interconnects/NAME projects/PROJECT_ID/global/interconnects/NAME - https://compute.googleapis.com/compute/projects/PROJECT_ID /global/interconnects/NAME ", +"type": "string" +}, +"vlanTags": { +"description": "To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. - Port mode pseudowires must configure a value of `-1` for both endpoints. ", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +} +}, +"type": "object" +}, +"WireGroupList": { +"description": "Response for the list request.", +"id": "WireGroupList", +"properties": { +"etag": { +"type": "string" +}, +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of wire group resources.", +"items": { +"$ref": "WireGroup" +}, +"type": "array" +}, +"kind": { +"default": "compute#wireGroup", +"description": "[Output Only] Type of the resource. Always compute#wireGroups for wire groups.", +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", +"type": "string" +}, +"unreachables": { +"description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", +"items": { +"type": "string" +}, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"WireGroupProperties": { +"description": "The properties of a wire group. These properties determine how a group of redundant wires are created and managed.", +"id": "WireGroupProperties", +"properties": { +"type": { +"description": "The type of the wire group, one of the following: - WIRE: a single pseudowire over two Interconnect connections with no redundancy. - REDUNDANT: two pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Each pseudowire connects Interconnect connections in matching edge availability domains of the two metros. - BOX_AND_CROSS: four pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Two pseudowires connect Interconnect connections in matching edge availability domains of the two metros. Two additional pseudowires connect the non-matching edge availability domains of the two metros. ", +"enum": [ +"BOX_AND_CROSS", +"REDUNDANT", +"WIRE" +], +"enumDescriptions": [ +"Four pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Two pseudowires connect Interconnect connections in matching edge availability domains of the two metros. Two additional pseudowires connect the non-matching edge availability domains of the two metros.", +"Two pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Each pseudowire connects Interconnect connections in matching edge availability domains of the two metros.", +"A single pseudowire over two Interconnect connections with no redundancy." +], +"type": "string" +} +}, +"type": "object" +}, +"WireGroupServiceLevel": { +"description": "Service level details determined for the wire group configuration.", +"id": "WireGroupServiceLevel", +"properties": { +"availabilityClass": { +"description": "[Output Only] The availability SLA that the wire group qualifies for. One of the following: `NO_AVAILABILITY_SLA`, `AVAILABILITY_99`, or `AVAILABILITY_999`.", +"enum": [ +"AVAILABILITY_99", +"AVAILABILITY_999", +"NO_AVAILABILITY_SLA" +], +"enumDescriptions": [ +"99% availability", +"99.9% availability", +"No SLA" +], +"type": "string" +} +}, +"type": "object" +}, +"WireGroupWireInputs": { +"description": "Optional settings for individual wires. Allows wire-level control that can be useful for migration purposes. If you use this field, you opt-out of the SLA for the wire group.", +"id": "WireGroupWireInputs", +"properties": { +"adminEnabled": { +"description": "Indicates whether the wire is enabled. When false, the wire is disabled. When true and when the wire group of the wire is also enabled, the wire is enabled. Defaults to true.", +"type": "boolean" +}, +"wirePropertyOverrides": { +"$ref": "WireProperties", +"description": "The overridden properties for the wire. Any properties that are not overridden are omitted from the object. Review the following guidelines: - If you apply wire overrides to a wire and its wire group bandwidth configuration is set to `SHARED_WITH_WIRE_GROUP`, the `meteredBandwidth` and `unmeteredBandwidth` properties must not differ from the wire group. - Overrides generate a `configurationNotice`. Ensure that differences in wire configuration are temporary. An example use case for wire overrides is slowly rolling out configuration changes to individual wires in a wire group. " +} +}, +"type": "object" +}, +"WireProperties": { +"description": "The properties of a wire.", +"id": "WireProperties", +"properties": { +"bandwidthAllocation": { +"description": "The configuration of the bandwidth allocation, one of the following: - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group. - SHARED_WITH_WIRE_GROUP: configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires. ", +"enum": [ +"ALLOCATE_PER_WIRE", +"SHARED_WITH_WIRE_GROUP" +], +"enumDescriptions": [ +"Configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group.", +"Configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group. For example, with a four-wire box-and-cross group, when one Interconnect connection is down, the unmetered bandwidth of the two down wires is reallocated to the remaining up wires." +], +"type": "string" +}, +"bandwidthMetered": { +"description": "The metered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. The default value is `0`. You can specify unlimited bandwidth by entering `-1`. However, actual data transfer is limited by the port speed.", +"format": "int64", +"type": "string" +}, +"bandwidthUnmetered": { +"description": "The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10.", +"format": "int64", +"type": "string" +}, +"faultResponse": { +"description": "Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires. ", +"enum": [ +"DISABLE_PORT", +"NONE" +], +"enumDescriptions": [ +"Set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires.", +"Default." +], +"type": "string" +}, +"networkServiceClass": { +"description": "The network service class.", +"enum": [ +"BRONZE", +"GOLD" +], +"enumDescriptions": [ +"The default service class.", +"A higher service class." +], +"type": "string" +} +}, +"type": "object" +}, "XpnHostList": { "id": "XpnHostList", "properties": { diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index 64140733f9..2b62efb3b5 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -20482,6 +20482,56 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"listPreconfiguredExpressionSets": { +"description": "Gets the current list of preconfigured Web Application Firewall (WAF) expressions.", +"flatPath": "locations/global/securityPolicies/listPreconfiguredExpressionSets", +"httpMethod": "GET", +"id": "compute.organizationSecurityPolicies.listPreconfiguredExpressionSets", +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"parentId": { +"description": "Parent ID for this request.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "locations/global/securityPolicies/listPreconfiguredExpressionSets", +"response": { +"$ref": "SecurityPoliciesListPreconfiguredExpressionSetsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "move": { "description": "Moves the specified security policy.", "flatPath": "locations/global/securityPolicies/{securityPolicy}/move", @@ -27765,7 +27815,7 @@ ] }, "get": { -"description": "Returns the specified multi-MIG resource.", +"description": "Returns all the details of a specific multi-MIG.", "flatPath": "projects/{project}/regions/{region}/multiMigs/{multiMig}", "httpMethod": "GET", "id": "compute.regionMultiMigs.get", @@ -27832,7 +27882,7 @@ "type": "string" }, "requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents you from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -32172,206 +32222,48 @@ } } }, -"reservations": { +"reservationBlocks": { "methods": { -"aggregatedList": { -"description": "Retrieves an aggregated list of reservations. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", -"flatPath": "projects/{project}/aggregated/reservations", -"httpMethod": "GET", -"id": "compute.reservations.aggregatedList", -"parameterOrder": [ -"project" -], -"parameters": { -"filter": { -"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", -"location": "query", -"type": "string" -}, -"includeAllScopes": { -"description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", -"location": "query", -"type": "boolean" -}, -"maxResults": { -"default": "500", -"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", -"format": "uint32", -"location": "query", -"minimum": "0", -"type": "integer" -}, -"orderBy": { -"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", -"location": "query", -"type": "string" -}, -"pageToken": { -"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", -"location": "query", -"type": "string" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"returnPartialSuccess": { -"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", -"location": "query", -"type": "boolean" -}, -"serviceProjectNumber": { -"description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", -"format": "int64", -"location": "query", -"type": "string" -} -}, -"path": "projects/{project}/aggregated/reservations", -"response": { -"$ref": "ReservationAggregatedList" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" -] -}, -"delete": { -"description": "Deletes the specified reservation.", -"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", -"httpMethod": "DELETE", -"id": "compute.reservations.delete", -"parameterOrder": [ -"project", -"zone", -"reservation" -], -"parameters": { -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -}, -"reservation": { -"description": "Name of the reservation to delete.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -}, -"zone": { -"description": "Name of the zone for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/zones/{zone}/reservations/{reservation}", -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, "get": { -"description": "Retrieves information about the specified reservation.", -"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", +"description": "Retrieves information about the specified reservation block.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}", "httpMethod": "GET", -"id": "compute.reservations.get", +"id": "compute.reservationBlocks.get", "parameterOrder": [ "project", "zone", -"reservation" +"reservation", +"reservationBlock" ], "parameters": { "project": { "description": "Project ID for this request.", "location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, "reservation": { -"description": "Name of the reservation to retrieve.", +"description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, -"zone": { -"description": "Name of the zone for this request.", +"reservationBlock": { +"description": "The name of the reservation block. Name should conform to RFC1035 or be a resource ID.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/zones/{zone}/reservations/{reservation}", -"response": { -"$ref": "Reservation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" -] -}, -"getIamPolicy": { -"description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", -"flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy", -"httpMethod": "GET", -"id": "compute.reservations.getIamPolicy", -"parameterOrder": [ -"project", -"zone", -"resource" -], -"parameters": { -"optionsRequestedPolicyVersion": { -"description": "Requested IAM Policy version.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"resource": { -"description": "Name or id of the resource for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, "zone": { -"description": "The name of the zone for this request.", +"description": "Name of the zone for this request. Zone name should conform to RFC1035.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, -"path": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy", +"path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}", "response": { -"$ref": "Policy" +"$ref": "ReservationBlocksGetResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32379,56 +32271,333 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"insert": { -"description": "Creates a new reservation. For more information, read Reserving zonal resources.", -"flatPath": "projects/{project}/zones/{zone}/reservations", -"httpMethod": "POST", -"id": "compute.reservations.insert", -"parameterOrder": [ -"project", -"zone" -], -"parameters": { -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -}, -"zone": { -"description": "Name of the zone for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/zones/{zone}/reservations", -"request": { -"$ref": "Reservation" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, "list": { -"description": "A list of all the reservations that have been configured for the specified project in specified zone.", -"flatPath": "projects/{project}/zones/{zone}/reservations", +"description": "Retrieves a list of reservation blocks under a single reservation.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", "httpMethod": "GET", -"id": "compute.reservations.list", +"id": "compute.reservationBlocks.list", "parameterOrder": [ "project", -"zone" +"zone", +"reservation" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"reservation": { +"description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +}, +"zone": { +"description": "Name of the zone for this request. Zone name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", +"response": { +"$ref": "ReservationBlocksListResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, +"reservations": { +"methods": { +"aggregatedList": { +"description": "Retrieves an aggregated list of reservations. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", +"flatPath": "projects/{project}/aggregated/reservations", +"httpMethod": "GET", +"id": "compute.reservations.aggregatedList", +"parameterOrder": [ +"project" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"includeAllScopes": { +"description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", +"location": "query", +"type": "boolean" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +}, +"serviceProjectNumber": { +"description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/aggregated/reservations", +"response": { +"$ref": "ReservationAggregatedList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"delete": { +"description": "Deletes the specified reservation.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", +"httpMethod": "DELETE", +"id": "compute.reservations.delete", +"parameterOrder": [ +"project", +"zone", +"reservation" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"reservation": { +"description": "Name of the reservation to delete.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/reservations/{reservation}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Retrieves information about the specified reservation.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", +"httpMethod": "GET", +"id": "compute.reservations.get", +"parameterOrder": [ +"project", +"zone", +"reservation" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"reservation": { +"description": "Name of the reservation to retrieve.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/reservations/{reservation}", +"response": { +"$ref": "Reservation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy", +"httpMethod": "GET", +"id": "compute.reservations.getIamPolicy", +"parameterOrder": [ +"project", +"zone", +"resource" +], +"parameters": { +"optionsRequestedPolicyVersion": { +"description": "Requested IAM Policy version.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "Creates a new reservation. For more information, read Reserving zonal resources.", +"flatPath": "projects/{project}/zones/{zone}/reservations", +"httpMethod": "POST", +"id": "compute.reservations.insert", +"parameterOrder": [ +"project", +"zone" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/reservations", +"request": { +"$ref": "Reservation" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "A list of all the reservations that have been configured for the specified project in specified zone.", +"flatPath": "projects/{project}/zones/{zone}/reservations", +"httpMethod": "GET", +"id": "compute.reservations.list", +"parameterOrder": [ +"project", +"zone" ], "parameters": { "filter": { @@ -42526,7 +42695,7 @@ } } }, -"revision": "20241001", +"revision": "20241015", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -43909,6 +44078,15 @@ false "description": "[Output Only] Contains output only fields.", "id": "AllocationResourceStatus", "properties": { +"reservationBlockCount": { +"description": "The number of reservation blocks associated with this reservation.", +"format": "int32", +"type": "integer" +}, +"reservationMaintenance": { +"$ref": "GroupMaintenanceInfo", +"description": "Maintenance information for this reservation" +}, "specificSkuAllocation": { "$ref": "AllocationResourceStatusSpecificSKUAllocation", "description": "Allocation Properties of this reservation." @@ -44318,7 +44496,7 @@ false "type": "object" }, "AuditConfig": { -"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.", +"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "AuditConfig", "properties": { "auditLogConfigs": { @@ -47300,10 +47478,6 @@ false "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", "properties": { -"bindingId": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -}, "condition": { "$ref": "Expr", "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." @@ -48189,86 +48363,6 @@ false }, "type": "object" }, -"Condition": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "Condition", -"properties": { -"iam": { -"description": "This is deprecated and has no effect. Do not use.", -"enum": [ -"APPROVER", -"ATTRIBUTION", -"AUTHORITY", -"CREDENTIALS_TYPE", -"CREDS_ASSERTION", -"JUSTIFICATION_TYPE", -"NO_ATTR", -"SECURITY_REALM" -], -"enumDescriptions": [ -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use." -], -"type": "string" -}, -"op": { -"description": "This is deprecated and has no effect. Do not use.", -"enum": [ -"DISCHARGED", -"EQUALS", -"IN", -"NOT_EQUALS", -"NOT_IN", -"NO_OP" -], -"enumDescriptions": [ -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use." -], -"type": "string" -}, -"svc": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -}, -"sys": { -"description": "This is deprecated and has no effect. Do not use.", -"enum": [ -"IP", -"NAME", -"NO_ATTR", -"REGION", -"SERVICE" -], -"enumDescriptions": [ -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use." -], -"type": "string" -}, -"values": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "ConfidentialInstanceConfig": { "description": "A set of Confidential Instance options.", "id": "ConfidentialInstanceConfig", @@ -52224,15 +52318,47 @@ false "description": "[Output Only] The creation timestamp for this future reservation in RFC3339 text format.", "type": "string" }, +"deploymentType": { +"description": "Type of the deployment requested as part of future reservation.", +"enum": [ +"DENSE", +"DEPLOYMENT_TYPE_UNSPECIFIED", +"FLEXIBLE" +], +"enumDescriptions": [ +"The reserved capacity is made up of densely deployed reservation blocks.", +"", +"The reserved capacity is made up of highly flexible, logical reservation blocks." +], +"type": "string" +}, "description": { "description": "An optional description of this resource. Provide this property when you create the future reservation.", "type": "string" }, +"enableOpportunisticMaintenance": { +"description": "Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the FR by customers, and will be used for reservation and reservation block maintenance .", +"type": "boolean" +}, "id": { "description": "[Output Only] A unique identifier for this future reservation. The server defines this identifier.", "format": "uint64", "type": "string" }, +"instanceTerminationAction": { +"description": "Action to take during reservation termination.", +"enum": [ +"DELETE", +"INSTANCE_TERMINATION_ACTION_UNSPECIFIED", +"STOP" +], +"enumDescriptions": [ +"Delete the VM.", +"Default value. This value is unused.", +"Stop the VM without storing in-memory content. default action." +], +"type": "string" +}, "kind": { "default": "compute#futureReservation", "description": "[Output Only] Type of the resource. Always compute#futureReservation for future reservations.", @@ -52266,6 +52392,24 @@ false ], "type": "string" }, +"reservationName": { +"description": "Name of reservations where the capacity is provisioned at the time of delivery of future reservations. If the reservation with the given name does not exist already, it is created automatically at the time of Approval with INACTIVE state till specified start-time. Either provide the reservation_name or a name_prefix.", +"type": "string" +}, +"schedulingType": { +"description": "Maintenance information for this reservation", +"enum": [ +"GROUPED", +"GROUP_MAINTENANCE_TYPE_UNSPECIFIED", +"INDEPENDENT" +], +"enumDescriptions": [ +"Maintenance on all reserved instances in the reservation is synchronized.", +"Unknown maintenance type.", +"Maintenance is not synchronized for this reservation. Instead, each instance has its own maintenance window." +], +"type": "string" +}, "selfLink": { "description": "[Output Only] Server-defined fully-qualified URL for this resource.", "type": "string" @@ -52278,6 +52422,10 @@ false "$ref": "ShareSettings", "description": "List of Projects/Folders to share with." }, +"specificReservationRequired": { +"description": "Indicates whether the auto-created reservation can be consumed by VMs with affinity for \"any\" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation.", +"type": "boolean" +}, "specificSkuProperties": { "$ref": "FutureReservationSpecificSKUProperties", "description": "Future Reservation configuration to indicate instance properties and total count." @@ -53115,6 +53263,45 @@ false }, "type": "object" }, +"GroupMaintenanceInfo": { +"description": "Maintenance Info for ReservationBlocks.", +"id": "GroupMaintenanceInfo", +"properties": { +"enableOpportunisticMaintenance": { +"description": "This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible.", +"type": "boolean" +}, +"maintenanceOngoingCount": { +"description": "Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.", +"format": "int32", +"type": "integer" +}, +"maintenancePendingCount": { +"description": "Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance.", +"format": "int32", +"type": "integer" +}, +"schedulingType": { +"description": "The type of maintenance for the reservation.", +"enum": [ +"GROUPED", +"GROUP_MAINTENANCE_TYPE_UNSPECIFIED", +"INDEPENDENT" +], +"enumDescriptions": [ +"Maintenance on all reserved instances in the reservation is synchronized.", +"Unknown maintenance type.", +"Maintenance is not synchronized for this reservation. Instead, each instance has its own maintenance window." +], +"type": "string" +}, +"upcomingGroupMaintenance": { +"$ref": "UpcomingMaintenance", +"description": "Maintenance information on this group of VMs." +} +}, +"type": "object" +}, "GuestAttributes": { "description": "A guest attributes entry.", "id": "GuestAttributes", @@ -56634,7 +56821,7 @@ false "type": "string" }, "namedPorts": { -"description": "Named ports configured for the Instance Groups complementary to this Instance Group Manager.", +"description": "[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.", "items": { "$ref": "NamedPort" }, @@ -59949,7 +60136,7 @@ false "id": "InstancesGetEffectiveFirewallsResponse", "properties": { "firewallPolicys": { -"description": "Effective firewalls from firewall policies.", +"description": "[Output Only] Effective firewalls from firewall policies.", "items": { "$ref": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" }, @@ -59990,7 +60177,7 @@ false "type": "integer" }, "rules": { -"description": "The rules that apply to the network.", +"description": "[Output Only] The rules that apply to the instance. Only rules that target the specific VM instance are returned if target service accounts or target secure tags are specified in the rules.", "items": { "$ref": "FirewallPolicyRule" }, @@ -60910,10 +61097,18 @@ false "description": "Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview.", "id": "Interconnect", "properties": { +"aaiEnabled": { +"description": "Enable or disable the application awareness feature on this Cloud Interconnect.", +"type": "boolean" +}, "adminEnabled": { "description": "Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.", "type": "boolean" }, +"applicationAwareInterconnect": { +"$ref": "InterconnectApplicationAwareInterconnect", +"description": "Configuration information for application awareness on this Cloud Interconnect." +}, "availableFeatures": { "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails.", "items": { @@ -61108,6 +61303,81 @@ false }, "type": "object" }, +"InterconnectApplicationAwareInterconnect": { +"description": "Configuration information for application awareness on this Cloud Interconnect.", +"id": "InterconnectApplicationAwareInterconnect", +"properties": { +"bandwidthPercentagePolicy": { +"$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy" +}, +"profileDescription": { +"description": "Description for the application awareness profile on this Cloud Interconnect.", +"type": "string" +}, +"shapeAveragePercentages": { +"description": "Optional field to specify a list of shape average percentages to be applied in conjunction with StrictPriorityPolicy or BandwidthPercentagePolicy.", +"items": { +"$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentage" +}, +"type": "array" +}, +"strictPriorityPolicy": { +"$ref": "InterconnectApplicationAwareInterconnectStrictPriorityPolicy" +} +}, +"type": "object" +}, +"InterconnectApplicationAwareInterconnectBandwidthPercentage": { +"description": "Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified.", +"id": "InterconnectApplicationAwareInterconnectBandwidthPercentage", +"properties": { +"percentage": { +"description": "Bandwidth percentage for a specific traffic class.", +"format": "uint32", +"type": "integer" +}, +"trafficClass": { +"description": "TrafficClass whose bandwidth percentage is being specified.", +"enum": [ +"TC1", +"TC2", +"TC3", +"TC4", +"TC5", +"TC6" +], +"enumDescriptions": [ +"Traffic Class 1, corresponding to DSCP ranges (0-7) 000xxx.", +"Traffic Class 2, corresponding to DSCP ranges (8-15) 001xxx.", +"Traffic Class 3, corresponding to DSCP ranges (16-23) 010xxx.", +"Traffic Class 4, corresponding to DSCP ranges (24-31) 011xxx.", +"Traffic Class 5, corresponding to DSCP ranges (32-47) 10xxxx.", +"Traffic Class 6, corresponding to DSCP ranges (48-63) 11xxxx." +], +"type": "string" +} +}, +"type": "object" +}, +"InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy": { +"id": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy", +"properties": { +"bandwidthPercentages": { +"description": "Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent.", +"items": { +"$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentage" +}, +"type": "array" +} +}, +"type": "object" +}, +"InterconnectApplicationAwareInterconnectStrictPriorityPolicy": { +"description": "Specify configuration for StrictPriorityPolicy.", +"id": "InterconnectApplicationAwareInterconnectStrictPriorityPolicy", +"properties": {}, +"type": "object" +}, "InterconnectAttachment": { "description": "Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments.", "id": "InterconnectAttachment", @@ -63501,102 +63771,6 @@ false }, "type": "object" }, -"LogConfig": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "LogConfig", -"properties": { -"cloudAudit": { -"$ref": "LogConfigCloudAuditOptions", -"description": "This is deprecated and has no effect. Do not use." -}, -"counter": { -"$ref": "LogConfigCounterOptions", -"description": "This is deprecated and has no effect. Do not use." -}, -"dataAccess": { -"$ref": "LogConfigDataAccessOptions", -"description": "This is deprecated and has no effect. Do not use." -} -}, -"type": "object" -}, -"LogConfigCloudAuditOptions": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "LogConfigCloudAuditOptions", -"properties": { -"logName": { -"description": "This is deprecated and has no effect. Do not use.", -"enum": [ -"ADMIN_ACTIVITY", -"DATA_ACCESS", -"UNSPECIFIED_LOG_NAME" -], -"enumDescriptions": [ -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use." -], -"type": "string" -} -}, -"type": "object" -}, -"LogConfigCounterOptions": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "LogConfigCounterOptions", -"properties": { -"customFields": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"$ref": "LogConfigCounterOptionsCustomField" -}, -"type": "array" -}, -"field": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -}, -"metric": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -} -}, -"type": "object" -}, -"LogConfigCounterOptionsCustomField": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "LogConfigCounterOptionsCustomField", -"properties": { -"name": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -}, -"value": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -} -}, -"type": "object" -}, -"LogConfigDataAccessOptions": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "LogConfigDataAccessOptions", -"properties": { -"logMode": { -"description": "This is deprecated and has no effect. Do not use.", -"enum": [ -"LOG_FAIL_CLOSED", -"LOG_MODE_UNSPECIFIED" -], -"enumDescriptions": [ -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use." -], -"type": "string" -} -}, -"type": "object" -}, "MachineImage": { "description": "Represents a machine image resource. A machine image is a Compute Engine resource that stores all the configuration, metadata, permissions, and data from one or more disks required to create a Virtual machine (VM) instance. For more information, see Machine images.", "id": "MachineImage", @@ -64820,7 +64994,7 @@ false "type": "string" }, "items": { -"description": "A list of multi-MIG resources.", +"description": "A list of multi-MIGs in the specified project and region.", "items": { "$ref": "MultiMig" }, @@ -67701,7 +67875,26 @@ false ], "type": "string" }, -"allowedSubnetPurposes": { +"interfaceTypes": { +"description": "If set, limits the interface types that the network supports. If empty, all interface types are supported.", +"items": { +"enum": [ +"GVNIC", +"IDPF", +"UNSPECIFIED_NIC_TYPE", +"VIRTIO_NET" +], +"enumDescriptions": [ +"GVNIC", +"IDPF", +"No type specified.", +"VIRTIO" +], +"type": "string" +}, +"type": "array" +}, +"subnetPurposes": { "description": "Specifies which subnetwork purposes are supported.", "items": { "enum": [ @@ -67716,7 +67909,7 @@ false }, "type": "array" }, -"allowedSubnetStackTypes": { +"subnetStackTypes": { "description": "Specifies which subnetwork stack types are supported.", "items": { "enum": [ @@ -67733,25 +67926,6 @@ false }, "type": "array" }, -"interfaceTypes": { -"description": "If set, limits the interface types that the network supports. If empty, all interface types are supported.", -"items": { -"enum": [ -"GVNIC", -"IDPF", -"UNSPECIFIED_NIC_TYPE", -"VIRTIO_NET" -], -"enumDescriptions": [ -"GVNIC", -"IDPF", -"No type specified.", -"VIRTIO" -], -"type": "string" -}, -"type": "array" -}, "unicast": { "description": "Specifies which type of unicast is supported.", "enum": [ @@ -68007,7 +68181,7 @@ false "id": "NetworksGetEffectiveFirewallsResponse", "properties": { "firewallPolicys": { -"description": "Effective firewalls from firewall policy.", +"description": "[Output Only] Effective firewalls from firewall policy. It returns Global Network Firewall Policies and Hierarchical Firewall Policies. Use regionNetworkFirewallPolicies.getEffectiveFirewalls to get Regional Network Firewall Policies as well.", "items": { "$ref": "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy" }, @@ -68048,7 +68222,7 @@ false "type": "integer" }, "rules": { -"description": "The rules that apply to the network.", +"description": "[Output Only] The rules that apply to the network.", "items": { "$ref": "FirewallPolicyRule" }, @@ -71993,13 +72167,6 @@ false "format": "byte", "type": "string" }, -"rules": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"$ref": "Rule" -}, -"type": "array" -}, "version": { "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", @@ -75551,7 +75718,7 @@ false "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse", "properties": { "firewallPolicys": { -"description": "Effective firewalls from firewall policy.", +"description": "[Output only] Effective firewalls from firewall policy. It applies to Regional Network Firewall Policies in the specified region, Global Network Firewall Policies and Hierachial Firewall Policies which are associated with the network.", "items": { "$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" }, @@ -75584,7 +75751,7 @@ false "type": "integer" }, "rules": { -"description": "The rules that apply to the network.", +"description": "[Output only] The rules that apply to the network.", "items": { "$ref": "FirewallPolicyRule" }, @@ -75716,6 +75883,20 @@ false "description": "Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format.", "type": "string" }, +"deploymentType": { +"description": "Specifies the deployment strategy for this reservation.", +"enum": [ +"DENSE", +"DEPLOYMENT_TYPE_UNSPECIFIED", +"FLEXIBLE" +], +"enumDescriptions": [ +"The reserved capacity is made up of densely deployed reservation blocks.", +"", +"The reserved capacity is made up of highly flexible, logical reservation blocks." +], +"type": "string" +}, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" @@ -75725,6 +75906,20 @@ false "format": "uint64", "type": "string" }, +"instanceTerminationAction": { +"description": "Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type.", +"enum": [ +"DELETE", +"INSTANCE_TERMINATION_ACTION_UNSPECIFIED", +"STOP" +], +"enumDescriptions": [ +"Delete the VM.", +"Default value. This value is unused.", +"Stop the VM without storing in-memory content. default action." +], +"type": "string" +}, "kind": { "default": "compute#reservation", "description": "[Output Only] Type of the resource. Always compute#reservations for reservations.", @@ -75776,7 +75971,7 @@ false "type": "boolean" }, "status": { -"description": "[Output Only] The status of the reservation.", +"description": "[Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. ", "enum": [ "CREATING", "DELETING", @@ -75785,11 +75980,11 @@ false "UPDATING" ], "enumDescriptions": [ -"Resources are being allocated for the reservation.", -"Reservation is currently being deleted.", +"Reservation resources are being allocated.", +"Reservation deletion is in progress.", "", -"Reservation has allocated all its resources.", -"Reservation is currently being resized." +"Reservation resources have been allocated, and the reservation is ready for use.", +"Reservation update is in progress." ], "type": "string" }, @@ -75998,6 +76193,252 @@ false }, "type": "object" }, +"ReservationBlock": { +"description": "Represents a reservation block resource.", +"id": "ReservationBlock", +"properties": { +"count": { +"description": "[Output Only] The number of resources that are allocated in this reservation block.", +"format": "int32", +"type": "integer" +}, +"creationTimestamp": { +"description": "[Output Only] Creation timestamp in RFC3339 text format.", +"type": "string" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", +"format": "uint64", +"type": "string" +}, +"inUseCount": { +"description": "[Output Only] The number of instances that are currently in use on this reservation block.", +"format": "int32", +"type": "integer" +}, +"kind": { +"default": "compute#reservationBlock", +"description": "[Output Only] Type of the resource. Always compute#reservationBlock for reservation blocks.", +"type": "string" +}, +"name": { +"description": "[Output Only] The name of this reservation block generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"physicalTopology": { +"$ref": "ReservationBlockPhysicalTopology", +"description": "[Output Only] The physical topology of the reservation block." +}, +"reservationMaintenance": { +"$ref": "GroupMaintenanceInfo", +"description": "[Output Only] Maintenance information for this reservation block." +}, +"selfLink": { +"description": "[Output Only] Server-defined fully-qualified URL for this resource.", +"type": "string" +}, +"selfLinkWithId": { +"description": "[Output Only] Server-defined URL for this resource with the resource id.", +"type": "string" +}, +"status": { +"description": "[Output Only] Status of the reservation block.", +"enum": [ +"CREATING", +"DELETING", +"INVALID", +"READY" +], +"enumDescriptions": [ +"Resources are being allocated for the reservation block.", +"Reservation block is currently being deleted.", +"", +"Reservation block has allocated all its resources." +], +"type": "string" +}, +"zone": { +"description": "[Output Only] Zone in which the reservation block resides.", +"type": "string" +} +}, +"type": "object" +}, +"ReservationBlockPhysicalTopology": { +"id": "ReservationBlockPhysicalTopology", +"properties": { +"block": { +"description": "The hash of the capacity block within the cluster.", +"type": "string" +}, +"cluster": { +"description": "The cluster name of the reservation block.", +"type": "string" +} +}, +"type": "object" +}, +"ReservationBlocksGetResponse": { +"id": "ReservationBlocksGetResponse", +"properties": { +"resource": { +"$ref": "ReservationBlock" +} +}, +"type": "object" +}, +"ReservationBlocksListResponse": { +"description": "A list of reservation blocks under a single reservation.", +"id": "ReservationBlocksListResponse", +"properties": { +"id": { +"description": "Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of reservation block resources.", +"items": { +"$ref": "ReservationBlock" +}, +"type": "array" +}, +"kind": { +"default": "compute#reservationBlock", +"description": "Type of the resource. Always compute#reservationBlock for a list of reservation blocks.", +"type": "string" +}, +"nextPageToken": { +"description": "This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "Server-defined URL for this resource.", +"type": "string" +}, +"warning": { +"description": "Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "ReservationList": { "id": "ReservationList", "properties": { @@ -79549,72 +79990,6 @@ false }, "type": "object" }, -"Rule": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "Rule", -"properties": { -"action": { -"description": "This is deprecated and has no effect. Do not use.", -"enum": [ -"ALLOW", -"ALLOW_WITH_LOG", -"DENY", -"DENY_WITH_LOG", -"LOG", -"NO_ACTION" -], -"enumDescriptions": [ -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use." -], -"type": "string" -}, -"conditions": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"$ref": "Condition" -}, -"type": "array" -}, -"description": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -}, -"ins": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"type": "string" -}, -"type": "array" -}, -"logConfigs": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"$ref": "LogConfig" -}, -"type": "array" -}, -"notIns": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"type": "string" -}, -"type": "array" -}, -"permissions": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "SSLHealthCheck": { "id": "SSLHealthCheck", "properties": { diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index f9d771f582..6ba9d922b9 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -37421,7 +37421,7 @@ } } }, -"revision": "20241001", +"revision": "20241015", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -39140,7 +39140,7 @@ false "type": "object" }, "AuditConfig": { -"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.", +"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "AuditConfig", "properties": { "auditLogConfigs": { @@ -40694,7 +40694,8 @@ false "GENERATED_COOKIE", "HEADER_FIELD", "HTTP_COOKIE", -"NONE" +"NONE", +"STRONG_COOKIE_AFFINITY" ], "enumDescriptions": [ "2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.", @@ -40704,10 +40705,15 @@ false "Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.", "The hash is based on a user specified header field.", "The hash is based on a user provided cookie.", -"No session affinity. Connections from the same client IP may go to any instance in the pool." +"No session affinity. Connections from the same client IP may go to any instance in the pool.", +"Strong cookie-based affinity. Connections bearing the same cookie will be served by the same backend VM while that VM remains healthy, as long as the cookie has not expired." ], "type": "string" }, +"strongSessionAffinityCookie": { +"$ref": "BackendServiceHttpCookie", +"description": "Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY." +}, "subsetting": { "$ref": "Subsetting" }, @@ -41084,6 +41090,25 @@ false }, "type": "object" }, +"BackendServiceHttpCookie": { +"description": "The HTTP cookie used for stateful session affinity.", +"id": "BackendServiceHttpCookie", +"properties": { +"name": { +"description": "Name of the cookie.", +"type": "string" +}, +"path": { +"description": "Path to set for the cookie.", +"type": "string" +}, +"ttl": { +"$ref": "Duration", +"description": "Lifetime of the cookie." +} +}, +"type": "object" +}, "BackendServiceIAP": { "description": "Identity-Aware Proxy", "id": "BackendServiceIAP", @@ -41907,10 +41932,6 @@ false "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", "properties": { -"bindingId": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -}, "condition": { "$ref": "Expr", "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." @@ -42777,86 +42798,6 @@ false }, "type": "object" }, -"Condition": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "Condition", -"properties": { -"iam": { -"description": "This is deprecated and has no effect. Do not use.", -"enum": [ -"APPROVER", -"ATTRIBUTION", -"AUTHORITY", -"CREDENTIALS_TYPE", -"CREDS_ASSERTION", -"JUSTIFICATION_TYPE", -"NO_ATTR", -"SECURITY_REALM" -], -"enumDescriptions": [ -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use." -], -"type": "string" -}, -"op": { -"description": "This is deprecated and has no effect. Do not use.", -"enum": [ -"DISCHARGED", -"EQUALS", -"IN", -"NOT_EQUALS", -"NOT_IN", -"NO_OP" -], -"enumDescriptions": [ -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use." -], -"type": "string" -}, -"svc": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -}, -"sys": { -"description": "This is deprecated and has no effect. Do not use.", -"enum": [ -"IP", -"NAME", -"NO_ATTR", -"REGION", -"SERVICE" -], -"enumDescriptions": [ -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use." -], -"type": "string" -}, -"values": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "ConfidentialInstanceConfig": { "description": "A set of Confidential Instance options.", "id": "ConfidentialInstanceConfig", @@ -47988,6 +47929,22 @@ false "Health status of the endpoint is unknown." ], "type": "string" +}, +"ipv6HealthState": { +"description": "Health state of the ipv6 network endpoint determined based on the health checks configured.", +"enum": [ +"DRAINING", +"HEALTHY", +"UNHEALTHY", +"UNKNOWN" +], +"enumDescriptions": [ +"Endpoint is being drained.", +"Endpoint is healthy.", +"Endpoint is unhealthy.", +"Health status of the endpoint is unknown." +], +"type": "string" } }, "type": "object" @@ -50147,6 +50104,10 @@ false "format": "uint64", "type": "string" }, +"instanceFlexibilityPolicy": { +"$ref": "InstanceGroupManagerInstanceFlexibilityPolicy", +"description": "Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration." +}, "instanceGroup": { "description": "[Output Only] The URL of the Instance Group resource.", "type": "string" @@ -50188,7 +50149,7 @@ false "type": "string" }, "namedPorts": { -"description": "Named ports configured for the Instance Groups complementary to this Instance Group Manager.", +"description": "[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.", "items": { "$ref": "NamedPort" }, @@ -50509,6 +50470,37 @@ false }, "type": "object" }, +"InstanceGroupManagerInstanceFlexibilityPolicy": { +"id": "InstanceGroupManagerInstanceFlexibilityPolicy", +"properties": { +"instanceSelections": { +"additionalProperties": { +"$ref": "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection" +}, +"description": "Named instance selections configuring properties that the group will use when creating new VMs.", +"type": "object" +} +}, +"type": "object" +}, +"InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection": { +"id": "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection", +"properties": { +"machineTypes": { +"description": "Full machine-type names, e.g. \"n1-standard-16\".", +"items": { +"type": "string" +}, +"type": "array" +}, +"rank": { +"description": "Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "InstanceGroupManagerInstanceLifecyclePolicy": { "id": "InstanceGroupManagerInstanceLifecyclePolicy", "properties": { @@ -53230,7 +53222,7 @@ false "id": "InstancesGetEffectiveFirewallsResponse", "properties": { "firewallPolicys": { -"description": "Effective firewalls from firewall policies.", +"description": "[Output Only] Effective firewalls from firewall policies.", "items": { "$ref": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" }, @@ -53264,7 +53256,7 @@ false "type": "integer" }, "rules": { -"description": "The rules that apply to the network.", +"description": "[Output Only] The rules that apply to the instance. Only rules that target the specific VM instance are returned if target service accounts or target secure tags are specified in the rules.", "items": { "$ref": "FirewallPolicyRule" }, @@ -56739,102 +56731,6 @@ false }, "type": "object" }, -"LogConfig": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "LogConfig", -"properties": { -"cloudAudit": { -"$ref": "LogConfigCloudAuditOptions", -"description": "This is deprecated and has no effect. Do not use." -}, -"counter": { -"$ref": "LogConfigCounterOptions", -"description": "This is deprecated and has no effect. Do not use." -}, -"dataAccess": { -"$ref": "LogConfigDataAccessOptions", -"description": "This is deprecated and has no effect. Do not use." -} -}, -"type": "object" -}, -"LogConfigCloudAuditOptions": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "LogConfigCloudAuditOptions", -"properties": { -"logName": { -"description": "This is deprecated and has no effect. Do not use.", -"enum": [ -"ADMIN_ACTIVITY", -"DATA_ACCESS", -"UNSPECIFIED_LOG_NAME" -], -"enumDescriptions": [ -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use." -], -"type": "string" -} -}, -"type": "object" -}, -"LogConfigCounterOptions": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "LogConfigCounterOptions", -"properties": { -"customFields": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"$ref": "LogConfigCounterOptionsCustomField" -}, -"type": "array" -}, -"field": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -}, -"metric": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -} -}, -"type": "object" -}, -"LogConfigCounterOptionsCustomField": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "LogConfigCounterOptionsCustomField", -"properties": { -"name": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -}, -"value": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -} -}, -"type": "object" -}, -"LogConfigDataAccessOptions": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "LogConfigDataAccessOptions", -"properties": { -"logMode": { -"description": "This is deprecated and has no effect. Do not use.", -"enum": [ -"LOG_FAIL_CLOSED", -"LOG_MODE_UNSPECIFIED" -], -"enumDescriptions": [ -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use." -], -"type": "string" -} -}, -"type": "object" -}, "MachineImage": { "description": "Represents a machine image resource. A machine image is a Compute Engine resource that stores all the configuration, metadata, permissions, and data from one or more disks required to create a Virtual machine (VM) instance. For more information, see Machine images.", "id": "MachineImage", @@ -57759,6 +57655,10 @@ false "$ref": "PreservedState", "description": "[Output Only] Preserved state generated based on stateful policy for this instance." }, +"propertiesFromFlexibilityPolicy": { +"$ref": "ManagedInstancePropertiesFromFlexibilityPolicy", +"description": "[Output Only] Instance properties selected for this instance resulting from InstanceFlexibilityPolicy." +}, "version": { "$ref": "ManagedInstanceVersion", "description": "[Output Only] Intended version of this instance." @@ -57848,6 +57748,16 @@ false }, "type": "object" }, +"ManagedInstancePropertiesFromFlexibilityPolicy": { +"id": "ManagedInstancePropertiesFromFlexibilityPolicy", +"properties": { +"machineType": { +"description": "The machine type to be used for this instance.", +"type": "string" +} +}, +"type": "object" +}, "ManagedInstanceVersion": { "id": "ManagedInstanceVersion", "properties": { @@ -59102,6 +59012,10 @@ false "description": "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.", "type": "string" }, +"ipv6Address": { +"description": "Optional IPv6 address of network endpoint.", +"type": "string" +}, "port": { "description": "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.", "format": "int32", @@ -60370,7 +60284,7 @@ false "id": "NetworksGetEffectiveFirewallsResponse", "properties": { "firewallPolicys": { -"description": "Effective firewalls from firewall policy.", +"description": "[Output Only] Effective firewalls from firewall policy. It returns Global Network Firewall Policies and Hierarchical Firewall Policies. Use regionNetworkFirewallPolicies.getEffectiveFirewalls to get Regional Network Firewall Policies as well.", "items": { "$ref": "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy" }, @@ -60404,7 +60318,7 @@ false "type": "integer" }, "rules": { -"description": "The rules that apply to the network.", +"description": "[Output Only] The rules that apply to the network.", "items": { "$ref": "FirewallPolicyRule" }, @@ -64291,13 +64205,6 @@ false "format": "byte", "type": "string" }, -"rules": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"$ref": "Rule" -}, -"type": "array" -}, "version": { "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", @@ -67552,7 +67459,7 @@ false "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse", "properties": { "firewallPolicys": { -"description": "Effective firewalls from firewall policy.", +"description": "[Output only] Effective firewalls from firewall policy. It applies to Regional Network Firewall Policies in the specified region, Global Network Firewall Policies and Hierachial Firewall Policies which are associated with the network.", "items": { "$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" }, @@ -67580,7 +67487,7 @@ false "type": "string" }, "rules": { -"description": "The rules that apply to the network.", +"description": "[Output only] The rules that apply to the network.", "items": { "$ref": "FirewallPolicyRule" }, @@ -67751,7 +67658,7 @@ false "type": "boolean" }, "status": { -"description": "[Output Only] The status of the reservation.", +"description": "[Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. ", "enum": [ "CREATING", "DELETING", @@ -67760,11 +67667,11 @@ false "UPDATING" ], "enumDescriptions": [ -"Resources are being allocated for the reservation.", -"Reservation is currently being deleted.", +"Reservation resources are being allocated.", +"Reservation deletion is in progress.", "", -"Reservation has allocated all its resources.", -"Reservation is currently being resized." +"Reservation resources have been allocated, and the reservation is ready for use.", +"Reservation update is in progress." ], "type": "string" }, @@ -71045,72 +70952,6 @@ false }, "type": "object" }, -"Rule": { -"description": "This is deprecated and has no effect. Do not use.", -"id": "Rule", -"properties": { -"action": { -"description": "This is deprecated and has no effect. Do not use.", -"enum": [ -"ALLOW", -"ALLOW_WITH_LOG", -"DENY", -"DENY_WITH_LOG", -"LOG", -"NO_ACTION" -], -"enumDescriptions": [ -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use.", -"This is deprecated and has no effect. Do not use." -], -"type": "string" -}, -"conditions": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"$ref": "Condition" -}, -"type": "array" -}, -"description": { -"description": "This is deprecated and has no effect. Do not use.", -"type": "string" -}, -"ins": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"type": "string" -}, -"type": "array" -}, -"logConfigs": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"$ref": "LogConfig" -}, -"type": "array" -}, -"notIns": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"type": "string" -}, -"type": "array" -}, -"permissions": { -"description": "This is deprecated and has no effect. Do not use.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "SSLHealthCheck": { "id": "SSLHealthCheck", "properties": { @@ -79550,7 +79391,8 @@ false "GENERATED_COOKIE", "HEADER_FIELD", "HTTP_COOKIE", -"NONE" +"NONE", +"STRONG_COOKIE_AFFINITY" ], "enumDescriptions": [ "2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.", @@ -79560,7 +79402,8 @@ false "Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.", "The hash is based on a user specified header field.", "The hash is based on a user provided cookie.", -"No session affinity. Connections from the same client IP may go to any instance in the pool." +"No session affinity. Connections from the same client IP may go to any instance in the pool.", +"Strong cookie-based affinity. Connections bearing the same cookie will be served by the same backend VM while that VM remains healthy, as long as the cookie has not expired." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/connectors.v1.json b/googleapiclient/discovery_cache/documents/connectors.v1.json index 555978586c..6714cf7151 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v1.json +++ b/googleapiclient/discovery_cache/documents/connectors.v1.json @@ -1095,6 +1095,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", "required": true, "type": "string" +}, +"schemaAsString": { +"description": "Optional. Flag to indicate if schema should be returned as string or not", +"location": "query", +"type": "boolean" } }, "path": "v1/{+parent}/runtimeActionSchemas", @@ -2497,7 +2502,7 @@ } } }, -"revision": "20240924", +"revision": "20241015", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -3463,6 +3468,10 @@ "format": "int64", "type": "string" }, +"connectorVersioningEnabled": { +"description": "Indicate whether connector versioning is enabled.", +"type": "boolean" +}, "deploymentModel": { "description": "Indicate whether connector is deployed on GKE/CloudRun", "enum": [ @@ -7036,6 +7045,11 @@ false "readOnly": true, "type": "array" }, +"inputSchemaAsString": { +"description": "Output only. Input schema as string.", +"readOnly": true, +"type": "string" +}, "resultJsonSchema": { "$ref": "JsonSchema", "description": "Output only. JsonSchema representation of this action's result metadata", @@ -7048,6 +7062,11 @@ false }, "readOnly": true, "type": "array" +}, +"resultSchemaAsString": { +"description": "Output only. Result schema as string.", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -7671,22 +7690,22 @@ false "id": "TimeOfDay", "properties": { "hours": { -"description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", +"description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, "minutes": { -"description": "Minutes of hour of day. Must be from 0 to 59.", +"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "type": "integer" }, "nanos": { -"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", +"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32", "type": "integer" }, "seconds": { -"description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", +"description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } diff --git a/googleapiclient/discovery_cache/documents/connectors.v2.json b/googleapiclient/discovery_cache/documents/connectors.v2.json index 450fee51c1..d385ecf5fa 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v2.json +++ b/googleapiclient/discovery_cache/documents/connectors.v2.json @@ -660,7 +660,7 @@ } } }, -"revision": "20240729", +"revision": "20241015", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AccessCredentials": { @@ -2403,22 +2403,22 @@ false "id": "TimeOfDay", "properties": { "hours": { -"description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", +"description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, "minutes": { -"description": "Minutes of hour of day. Must be from 0 to 59.", +"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "type": "integer" }, "nanos": { -"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", +"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32", "type": "integer" }, "seconds": { -"description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", +"description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } diff --git a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json index 3d98c30f31..951be79a4f 100644 --- a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json @@ -512,7 +512,7 @@ } } }, -"revision": "20241002", +"revision": "20241009", "rootUrl": "https://contactcenteraiplatform.googleapis.com/", "schemas": { "AdminUser": { @@ -555,7 +555,7 @@ "type": "object" }, "ContactCenter": { -"description": "Message describing ContactCenter object Next ID: 23", +"description": "Message describing ContactCenter object Next ID: 24", "id": "ContactCenter", "properties": { "adminUser": { diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index a89f44ee2c..8129f571eb 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -109,6 +109,62 @@ "resources": { "locations": { "methods": { +"bulkDownloadFeedbackLabels": { +"description": "Download feedback labels in bulk.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:bulkDownloadFeedbackLabels", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.bulkDownloadFeedbackLabels", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource for new feedback labels.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}:bulkDownloadFeedbackLabels", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"bulkUploadFeedbackLabels": { +"description": "Upload feedback labels in bulk.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:bulkUploadFeedbackLabels", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.bulkUploadFeedbackLabels", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource for new feedback labels.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}:bulkUploadFeedbackLabels", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "getEncryptionSpec": { "description": "Gets location-level encryption key specification.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec", @@ -159,6 +215,75 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"listAllFeedbackLabels": { +"description": "List all feedback labels by project number.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:listAllFeedbackLabels", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.listAllFeedbackLabels", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource of all feedback labels per project.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}:listAllFeedbackLabels", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"queryMetrics": { +"description": "Query metrics.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:queryMetrics", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.queryMetrics", +"parameterOrder": [ +"location" +], +"parameters": { +"location": { +"description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+location}:queryMetrics", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "updateSettings": { "description": "Updates project-level settings.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/settings", @@ -195,217 +320,212 @@ } }, "resources": { -"conversations": { +"analysisRules": { "methods": { -"bulkAnalyze": { -"description": "Analyzes multiple conversations in a single request.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkAnalyze", +"create": { +"description": "Creates a analysis rule.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/analysisRules", "httpMethod": "POST", -"id": "contactcenterinsights.projects.locations.conversations.bulkAnalyze", +"id": "contactcenterinsights.projects.locations.analysisRules.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The parent resource to create analyses in.", +"description": "Required. The parent resource of the analysis rule. Required. The location to create a analysis rule for. Format: `projects//locations/` or `projects//locations/`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/conversations:bulkAnalyze", +"path": "v1/{+parent}/analysisRules", "request": { -"$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" +"$ref": "GoogleCloudContactcenterinsightsV1AnalysisRule" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudContactcenterinsightsV1AnalysisRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"bulkDelete": { -"description": "Deletes multiple conversations in a single request.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkDelete", -"httpMethod": "POST", -"id": "contactcenterinsights.projects.locations.conversations.bulkDelete", +"delete": { +"description": "Deletes a analysis rule.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", +"httpMethod": "DELETE", +"id": "contactcenterinsights.projects.locations.analysisRules.delete", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", +"name": { +"description": "Required. The name of the analysis rule to delete.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/conversations:bulkDelete", -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest" -}, +"path": "v1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"calculateStats": { -"description": "Gets conversation statistics.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations:calculateStats", +"get": { +"description": "Get a analysis rule.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", "httpMethod": "GET", -"id": "contactcenterinsights.projects.locations.conversations.calculateStats", +"id": "contactcenterinsights.projects.locations.analysisRules.get", "parameterOrder": [ -"location" +"name" ], "parameters": { -"filter": { -"description": "A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.", -"location": "query", -"type": "string" -}, -"location": { -"description": "Required. The location of the conversations.", +"name": { +"description": "Required. The name of the AnalysisRule to get.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+location}/conversations:calculateStats", +"path": "v1/{+name}", "response": { -"$ref": "GoogleCloudContactcenterinsightsV1CalculateStatsResponse" +"$ref": "GoogleCloudContactcenterinsightsV1AnalysisRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"create": { -"description": "Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations", -"httpMethod": "POST", -"id": "contactcenterinsights.projects.locations.conversations.create", +"list": { +"description": "Lists analysis rules.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/analysisRules", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.analysisRules.list", "parameterOrder": [ "parent" ], "parameters": { -"conversationId": { -"description": "A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", +"pageSize": { +"description": "Optional. The maximum number of analysis rule to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The value returned by the last `ListAnalysisRulesResponse`; indicates that this is a continuation of a prior `ListAnalysisRules` call and the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent resource of the conversation.", +"description": "Required. The parent resource of the analysis rules.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/conversations", -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1Conversation" -}, +"path": "v1/{+parent}/analysisRules", "response": { -"$ref": "GoogleCloudContactcenterinsightsV1Conversation" +"$ref": "GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"delete": { -"description": "Deletes a conversation.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", -"httpMethod": "DELETE", -"id": "contactcenterinsights.projects.locations.conversations.delete", +"patch": { +"description": "Updates a analysis rule.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", +"httpMethod": "PATCH", +"id": "contactcenterinsights.projects.locations.analysisRules.patch", "parameterOrder": [ "name" ], "parameters": { -"force": { -"description": "If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.", -"location": "query", -"type": "boolean" -}, "name": { -"description": "Required. The name of the conversation to delete.", +"description": "Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$", "required": true, "type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to be updated. If the update_mask is not provided, the update will be applied to all fields.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, "path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1AnalysisRule" +}, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleCloudContactcenterinsightsV1AnalysisRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"get": { -"description": "Gets a conversation.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", +"authorizedViewSet": { +"resources": { +"authorizedView": { +"methods": { +"calculateStats": { +"description": "Gets conversation statistics.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedView/{authorizedViewId}:calculateStats", "httpMethod": "GET", -"id": "contactcenterinsights.projects.locations.conversations.get", +"id": "contactcenterinsights.projects.locations.authorizedViewSet.authorizedView.calculateStats", "parameterOrder": [ -"name" +"location" ], "parameters": { -"name": { -"description": "Required. The name of the conversation to get.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", -"required": true, +"filter": { +"description": "A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.", +"location": "query", "type": "string" }, -"view": { -"description": "The level of details of the conversation. Default is `FULL`.", -"enum": [ -"CONVERSATION_VIEW_UNSPECIFIED", -"FULL", -"BASIC" -], -"enumDescriptions": [ -"The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", -"Populates all fields in the conversation.", -"Populates all fields in the conversation except the transcript." -], -"location": "query", +"location": { +"description": "Required. The location of the conversations.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedView/[^/]+$", +"required": true, "type": "string" } }, -"path": "v1/{+name}", +"path": "v1/{+location}:calculateStats", "response": { -"$ref": "GoogleCloudContactcenterinsightsV1Conversation" +"$ref": "GoogleCloudContactcenterinsightsV1CalculateStatsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"ingest": { -"description": "Imports conversations and processes them according to the user's configuration.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations:ingest", +"queryMetrics": { +"description": "Query metrics.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedView/{authorizedViewId}:queryMetrics", "httpMethod": "POST", -"id": "contactcenterinsights.projects.locations.conversations.ingest", +"id": "contactcenterinsights.projects.locations.authorizedViewSet.authorizedView.queryMetrics", "parameterOrder": [ -"parent" +"location" ], "parameters": { -"parent": { -"description": "Required. The parent resource for new conversations.", +"location": { +"description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedView/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/conversations:ingest", +"path": "v1/{+location}:queryMetrics", "request": { -"$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest" +"$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -413,86 +533,157 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"list": { -"description": "Lists conversations.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations", -"httpMethod": "GET", -"id": "contactcenterinsights.projects.locations.conversations.list", +"authorizedViews": { +"resources": { +"conversations": { +"resources": { +"feedbackLabels": { +"methods": { +"create": { +"description": "Create feedback label.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.create", "parameterOrder": [ "parent" ], "parameters": { -"filter": { -"description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", +"feedbackLabelId": { +"description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.", "location": "query", "type": "string" }, -"orderBy": { -"description": "Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).", -"location": "query", +"parent": { +"description": "Required. The parent resource of the feedback label.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/feedbackLabels", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" +}, +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Delete feedback label.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", +"httpMethod": "DELETE", +"id": "contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the feedback label to delete.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Get feedback label.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the feedback label to get.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "List feedback labels.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", +"location": "query", "type": "string" }, "pageSize": { -"description": "The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", +"description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.", +"description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent resource of the conversation.", +"description": "Required. The parent resource of the feedback labels.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "required": true, "type": "string" -}, -"view": { -"description": "The level of details of the conversation. Default is `BASIC`.", -"enum": [ -"CONVERSATION_VIEW_UNSPECIFIED", -"FULL", -"BASIC" -], -"enumDescriptions": [ -"The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", -"Populates all fields in the conversation.", -"Populates all fields in the conversation except the transcript." -], -"location": "query", -"type": "string" } }, -"path": "v1/{+parent}/conversations", +"path": "v1/{+parent}/feedbackLabels", "response": { -"$ref": "GoogleCloudContactcenterinsightsV1ListConversationsResponse" +"$ref": "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { -"description": "Updates a conversation.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", +"description": "Update feedback label.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "httpMethod": "PATCH", -"id": "contactcenterinsights.projects.locations.conversations.patch", +"id": "contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", +"description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or `data_source.dialogflow_source.audio_uri`", +"description": "Required. The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -500,38 +691,109 @@ }, "path": "v1/{+name}", "request": { -"$ref": "GoogleCloudContactcenterinsightsV1Conversation" +"$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "response": { -"$ref": "GoogleCloudContactcenterinsightsV1Conversation" +"$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +}, +"authorizedViewSets": { +"resources": { +"authorizedViews": { +"methods": { +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:getIamPolicy", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"upload": { -"description": "Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations:upload", +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:setIamPolicy", "httpMethod": "POST", -"id": "contactcenterinsights.projects.locations.conversations.upload", +"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.setIamPolicy", "parameterOrder": [ -"parent" +"resource" ], "parameters": { -"parent": { -"description": "Required. The parent resource of the conversation.", +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/conversations:upload", +"path": "v1/{+resource}:setIamPolicy", "request": { -"$ref": "GoogleCloudContactcenterinsightsV1UploadConversationRequest" +"$ref": "GoogleIamV1SetIamPolicyRequest" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:testIamPermissions", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -539,49 +801,59 @@ } }, "resources": { -"analyses": { +"conversations": { "methods": { "create": { -"description": "Creates an analysis. The long running operation is done when the analysis has completed.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses", +"description": "Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations", "httpMethod": "POST", -"id": "contactcenterinsights.projects.locations.conversations.analyses.create", +"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.create", "parameterOrder": [ "parent" ], "parameters": { +"conversationId": { +"description": "A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", +"location": "query", +"type": "string" +}, "parent": { -"description": "Required. The parent resource of the analysis.", +"description": "Required. The parent resource of the conversation.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/analyses", +"path": "v1/{+parent}/conversations", "request": { -"$ref": "GoogleCloudContactcenterinsightsV1Analysis" +"$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes an analysis.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}", +"description": "Deletes a conversation.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}", "httpMethod": "DELETE", -"id": "contactcenterinsights.projects.locations.conversations.analyses.delete", +"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.delete", "parameterOrder": [ "name" ], "parameters": { +"force": { +"description": "If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.", +"location": "query", +"type": "boolean" +}, "name": { -"description": "Required. The name of the analysis to delete.", +"description": "Required. The name of the conversation to delete.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/analyses/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "required": true, "type": "string" } @@ -595,35 +867,50 @@ ] }, "get": { -"description": "Gets an analysis.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}", +"description": "Gets a conversation.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}", "httpMethod": "GET", -"id": "contactcenterinsights.projects.locations.conversations.analyses.get", +"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the analysis to get.", +"description": "Required. The name of the conversation to get.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/analyses/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "The level of details of the conversation. Default is `FULL`.", +"enum": [ +"CONVERSATION_VIEW_UNSPECIFIED", +"FULL", +"BASIC" +], +"enumDescriptions": [ +"The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", +"Populates all fields in the conversation.", +"Populates all fields in the conversation except the transcript." +], +"location": "query", +"type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleCloudContactcenterinsightsV1Analysis" +"$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists analyses.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses", +"description": "Lists conversations.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations", "httpMethod": "GET", -"id": "contactcenterinsights.projects.locations.conversations.analyses.list", +"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.list", "parameterOrder": [ "parent" ], @@ -633,91 +920,127 @@ "location": "query", "type": "string" }, +"orderBy": { +"description": "Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).", +"location": "query", +"type": "string" +}, "pageSize": { -"description": "The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", +"description": "The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data.", +"description": "The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent resource of the analyses.", +"description": "Required. The parent resource of the conversation.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "The level of details of the conversation. Default is `BASIC`.", +"enum": [ +"CONVERSATION_VIEW_UNSPECIFIED", +"FULL", +"BASIC" +], +"enumDescriptions": [ +"The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", +"Populates all fields in the conversation.", +"Populates all fields in the conversation except the transcript." +], +"location": "query", +"type": "string" } }, -"path": "v1/{+parent}/analyses", +"path": "v1/{+parent}/conversations", "response": { -"$ref": "GoogleCloudContactcenterinsightsV1ListAnalysesResponse" +"$ref": "GoogleCloudContactcenterinsightsV1ListConversationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} }, -"encryptionSpec": { -"methods": { -"initialize": { -"description": "Initializes a location-level encryption key specification. An error will result if the location has resources already created before the initialization. After the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", -"httpMethod": "POST", -"id": "contactcenterinsights.projects.locations.encryptionSpec.initialize", +"patch": { +"description": "Updates a conversation.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}", +"httpMethod": "PATCH", +"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", +"description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "required": true, "type": "string" +}, +"updateMask": { +"description": "The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or `data_source.dialogflow_source.audio_uri`", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, -"path": "v1/{+name}:initialize", +"path": "v1/{+name}", "request": { -"$ref": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest" +"$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} }, -"insightsdata": { -"methods": { -"export": { -"description": "Export insights data to a destination defined in the request body.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/insightsdata:export", +"upload": { +"description": "Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:upload", "httpMethod": "POST", -"id": "contactcenterinsights.projects.locations.insightsdata.export", +"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.upload", "parameterOrder": [ "parent" ], "parameters": { +"conversationId": { +"description": "Optional. A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", +"location": "query", +"type": "string" +}, "parent": { -"description": "Required. The parent resource to export data from.", +"description": "Required. The parent resource of the conversation.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "required": true, "type": "string" +}, +"redactionConfig.deidentifyTemplate": { +"description": "The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`", +"location": "query", +"type": "string" +}, +"redactionConfig.inspectTemplate": { +"description": "The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`", +"location": "query", +"type": "string" +}, +"speechConfig.speechRecognizer": { +"description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`", +"location": "query", +"type": "string" } }, -"path": "v1/{+parent}/insightsdata:export", +"path": "v1/{+parent}/conversations:upload", "request": { -"$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest" +"$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -726,137 +1049,178 @@ "https://www.googleapis.com/auth/cloud-platform" ] } -} }, -"issueModels": { +"resources": { +"analyses": { "methods": { -"calculateIssueModelStats": { -"description": "Gets an issue model's statistics.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:calculateIssueModelStats", -"httpMethod": "GET", -"id": "contactcenterinsights.projects.locations.issueModels.calculateIssueModelStats", +"create": { +"description": "Creates an analysis. The long running operation is done when the analysis has completed.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.create", "parameterOrder": [ -"issueModel" +"parent" ], "parameters": { -"issueModel": { -"description": "Required. The resource name of the issue model to query against.", +"parent": { +"description": "Required. The parent resource of the analysis.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+issueModel}:calculateIssueModelStats", +"path": "v1/{+parent}/analyses", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1Analysis" +}, "response": { -"$ref": "GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"create": { -"description": "Creates an issue model.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels", -"httpMethod": "POST", -"id": "contactcenterinsights.projects.locations.issueModels.create", +"delete": { +"description": "Deletes an analysis.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses/{analysesId}", +"httpMethod": "DELETE", +"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.delete", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The parent resource of the issue model.", +"name": { +"description": "Required. The name of the analysis to delete.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/analyses/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/issueModels", -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1IssueModel" -}, +"path": "v1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"delete": { -"description": "Deletes an issue model.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", -"httpMethod": "DELETE", -"id": "contactcenterinsights.projects.locations.issueModels.delete", +"get": { +"description": "Gets an analysis.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses/{analysesId}", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the issue model to delete.", +"description": "Required. The name of the analysis to get.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/analyses/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudContactcenterinsightsV1Analysis" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"deploy": { -"description": "Deploys an issue model. Returns an error if a model is already deployed. An issue model can only be used in analysis after it has been deployed.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:deploy", +"list": { +"description": "Lists analyses.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource of the analyses.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/analyses", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1ListAnalysesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "contactcenterinsights.projects.locations.issueModels.deploy", +"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The issue model to deploy.", +"description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:deploy", -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest" -}, +"path": "v1/{+name}:cancel", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"export": { -"description": "Exports an issue model to the provided destination.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:export", -"httpMethod": "POST", -"id": "contactcenterinsights.projects.locations.issueModels.export", +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The issue model to export.", +"description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:export", -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest" -}, +"path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -864,51 +1228,75 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"get": { -"description": "Gets an issue model.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations", "httpMethod": "GET", -"id": "contactcenterinsights.projects.locations.issueModels.get", +"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.list", "parameterOrder": [ "name" ], "parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, "name": { -"description": "Required. The name of the issue model to get.", +"description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "required": true, "type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" } }, -"path": "v1/{+name}", +"path": "v1/{+name}/operations", "response": { -"$ref": "GoogleCloudContactcenterinsightsV1IssueModel" +"$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} +} +} +} +} }, -"import": { -"description": "Imports an issue model from a Cloud Storage bucket.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels:import", +"conversations": { +"methods": { +"bulkAnalyze": { +"description": "Analyzes multiple conversations in a single request.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkAnalyze", "httpMethod": "POST", -"id": "contactcenterinsights.projects.locations.issueModels.import", +"id": "contactcenterinsights.projects.locations.conversations.bulkAnalyze", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The parent resource of the issue model.", +"description": "Required. The parent resource to create analyses in.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/issueModels:import", +"path": "v1/{+parent}/conversations:bulkAnalyze", "request": { -"$ref": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest" +"$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -917,110 +1305,115 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"list": { -"description": "Lists issue models.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels", -"httpMethod": "GET", -"id": "contactcenterinsights.projects.locations.issueModels.list", +"bulkDelete": { +"description": "Deletes multiple conversations in a single request.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkDelete", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.conversations.bulkDelete", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The parent resource of the issue model.", +"description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/issueModels", +"path": "v1/{+parent}/conversations:bulkDelete", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest" +}, "response": { -"$ref": "GoogleCloudContactcenterinsightsV1ListIssueModelsResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"patch": { -"description": "Updates an issue model.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", -"httpMethod": "PATCH", -"id": "contactcenterinsights.projects.locations.issueModels.patch", +"calculateStats": { +"description": "Gets conversation statistics.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations:calculateStats", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.conversations.calculateStats", "parameterOrder": [ -"name" +"location" ], "parameters": { -"name": { -"description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", -"required": true, +"filter": { +"description": "A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.", +"location": "query", "type": "string" }, -"updateMask": { -"description": "The list of fields to be updated.", -"format": "google-fieldmask", -"location": "query", +"location": { +"description": "Required. The location of the conversations.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, "type": "string" } }, -"path": "v1/{+name}", -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1IssueModel" -}, +"path": "v1/{+location}/conversations:calculateStats", "response": { -"$ref": "GoogleCloudContactcenterinsightsV1IssueModel" +"$ref": "GoogleCloudContactcenterinsightsV1CalculateStatsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"undeploy": { -"description": "Undeploys an issue model. An issue model can not be used in analysis after it has been undeployed.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:undeploy", +"create": { +"description": "Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations", "httpMethod": "POST", -"id": "contactcenterinsights.projects.locations.issueModels.undeploy", +"id": "contactcenterinsights.projects.locations.conversations.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "Required. The issue model to undeploy.", +"conversationId": { +"description": "A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource of the conversation.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:undeploy", +"path": "v1/{+parent}/conversations", "request": { -"$ref": "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest" +"$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} }, -"resources": { -"issues": { -"methods": { "delete": { -"description": "Deletes an issue.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", +"description": "Deletes a conversation.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "httpMethod": "DELETE", -"id": "contactcenterinsights.projects.locations.issueModels.issues.delete", +"id": "contactcenterinsights.projects.locations.conversations.delete", "parameterOrder": [ "name" ], "parameters": { +"force": { +"description": "If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.", +"location": "query", +"type": "boolean" +}, "name": { -"description": "Required. The name of the issue to delete.", +"description": "Required. The name of the conversation to delete.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "required": true, "type": "string" } @@ -1034,73 +1427,152 @@ ] }, "get": { -"description": "Gets an issue.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", +"description": "Gets a conversation.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "httpMethod": "GET", -"id": "contactcenterinsights.projects.locations.issueModels.issues.get", +"id": "contactcenterinsights.projects.locations.conversations.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the issue to get.", +"description": "Required. The name of the conversation to get.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "The level of details of the conversation. Default is `FULL`.", +"enum": [ +"CONVERSATION_VIEW_UNSPECIFIED", +"FULL", +"BASIC" +], +"enumDescriptions": [ +"The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", +"Populates all fields in the conversation.", +"Populates all fields in the conversation except the transcript." +], +"location": "query", +"type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleCloudContactcenterinsightsV1Issue" +"$ref": "GoogleCloudContactcenterinsightsV1Conversation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"ingest": { +"description": "Imports conversations and processes them according to the user's configuration.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations:ingest", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.conversations.ingest", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource for new conversations.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/conversations:ingest", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists issues.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues", +"description": "Lists conversations.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations", "httpMethod": "GET", -"id": "contactcenterinsights.projects.locations.issueModels.issues.list", +"id": "contactcenterinsights.projects.locations.conversations.list", "parameterOrder": [ "parent" ], "parameters": { +"filter": { +"description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.", +"location": "query", +"type": "string" +}, "parent": { -"description": "Required. The parent resource of the issue.", +"description": "Required. The parent resource of the conversation.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "The level of details of the conversation. Default is `BASIC`.", +"enum": [ +"CONVERSATION_VIEW_UNSPECIFIED", +"FULL", +"BASIC" +], +"enumDescriptions": [ +"The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", +"Populates all fields in the conversation.", +"Populates all fields in the conversation except the transcript." +], +"location": "query", +"type": "string" } }, -"path": "v1/{+parent}/issues", +"path": "v1/{+parent}/conversations", "response": { -"$ref": "GoogleCloudContactcenterinsightsV1ListIssuesResponse" +"$ref": "GoogleCloudContactcenterinsightsV1ListConversationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { -"description": "Updates an issue.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", +"description": "Updates a conversation.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "httpMethod": "PATCH", -"id": "contactcenterinsights.projects.locations.issueModels.issues.patch", +"id": "contactcenterinsights.projects.locations.conversations.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", +"description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", +"description": "The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or `data_source.dialogflow_source.audio_uri`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1108,64 +1580,68 @@ }, "path": "v1/{+name}", "request": { -"$ref": "GoogleCloudContactcenterinsightsV1Issue" +"$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "response": { -"$ref": "GoogleCloudContactcenterinsightsV1Issue" +"$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} }, -"operations": { -"methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", +"upload": { +"description": "Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations:upload", "httpMethod": "POST", -"id": "contactcenterinsights.projects.locations.operations.cancel", +"id": "contactcenterinsights.projects.locations.conversations.upload", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", +"parent": { +"description": "Required. The parent resource of the conversation.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:cancel", +"path": "v1/{+parent}/conversations:upload", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1UploadConversationRequest" +}, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} }, -"get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", -"httpMethod": "GET", -"id": "contactcenterinsights.projects.locations.operations.get", +"resources": { +"analyses": { +"methods": { +"create": { +"description": "Creates an analysis. The long running operation is done when the analysis has completed.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.conversations.analyses.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource.", +"parent": { +"description": "Required. The parent resource of the analysis.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}", +"path": "v1/{+parent}/analyses", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1Analysis" +}, "response": { "$ref": "GoogleLongrunningOperation" }, @@ -1173,42 +1649,92 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", -"httpMethod": "GET", -"id": "contactcenterinsights.projects.locations.operations.list", +"delete": { +"description": "Deletes an analysis.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}", +"httpMethod": "DELETE", +"id": "contactcenterinsights.projects.locations.conversations.analyses.delete", "parameterOrder": [ "name" ], "parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", +"name": { +"description": "Required. The name of the analysis to delete.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/analyses/[^/]+$", +"required": true, "type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] }, +"get": { +"description": "Gets an analysis.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.conversations.analyses.get", +"parameterOrder": [ +"name" +], +"parameters": { "name": { -"description": "The name of the operation's parent resource.", +"description": "Required. The name of the analysis to get.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/analyses/[^/]+$", "required": true, "type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1Analysis" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists analyses.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.conversations.analyses.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", +"location": "query", +"type": "string" }, "pageSize": { -"description": "The standard list page size.", +"description": "The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data.", "location": "query", "type": "string" +}, +"parent": { +"description": "Required. The parent resource of the analyses.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", +"required": true, +"type": "string" } }, -"path": "v1/{+name}/operations", +"path": "v1/{+parent}/analyses", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudContactcenterinsightsV1ListAnalysesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -1216,49 +1742,54 @@ } } }, -"phraseMatchers": { +"feedbackLabels": { "methods": { "create": { -"description": "Creates a phrase matcher.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers", +"description": "Create feedback label.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels", "httpMethod": "POST", -"id": "contactcenterinsights.projects.locations.phraseMatchers.create", +"id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.create", "parameterOrder": [ "parent" ], "parameters": { +"feedbackLabelId": { +"description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.", +"location": "query", +"type": "string" +}, "parent": { -"description": "Required. The parent resource of the phrase matcher. Required. The location to create a phrase matcher for. Format: `projects//locations/` or `projects//locations/`", +"description": "Required. The parent resource of the feedback label.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/phraseMatchers", +"path": "v1/{+parent}/feedbackLabels", "request": { -"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatcher" +"$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "response": { -"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatcher" +"$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a phrase matcher.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", +"description": "Delete feedback label.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "httpMethod": "DELETE", -"id": "contactcenterinsights.projects.locations.phraseMatchers.delete", +"id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the phrase matcher to delete.", +"description": "Required. The name of the feedback label to delete.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "required": true, "type": "string" } @@ -1272,89 +1803,89 @@ ] }, "get": { -"description": "Gets a phrase matcher.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", +"description": "Get feedback label.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "httpMethod": "GET", -"id": "contactcenterinsights.projects.locations.phraseMatchers.get", +"id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the phrase matcher to get.", +"description": "Required. The name of the feedback label to get.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatcher" +"$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists phrase matchers.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers", +"description": "List feedback labels.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels", "httpMethod": "GET", -"id": "contactcenterinsights.projects.locations.phraseMatchers.list", +"id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { -"description": "A filter to reduce results to a specific subset. Useful for querying phrase matchers with specific properties.", +"description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "location": "query", "type": "string" }, "pageSize": { -"description": "The maximum number of phrase matchers to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", +"description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListPhraseMatchersResponse`. This value indicates that this is a continuation of a prior `ListPhraseMatchers` call and that the system should return the next page of data.", +"description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent resource of the phrase matcher.", +"description": "Required. The parent resource of the feedback labels.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/phraseMatchers", +"path": "v1/{+parent}/feedbackLabels", "response": { -"$ref": "GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse" +"$ref": "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { -"description": "Updates a phrase matcher.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", +"description": "Update feedback label.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "httpMethod": "PATCH", -"id": "contactcenterinsights.projects.locations.phraseMatchers.patch", +"id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", +"description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", +"description": "Required. The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1362,1180 +1893,3432 @@ }, "path": "v1/{+name}", "request": { -"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatcher" +"$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "response": { -"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatcher" +"$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } +} +} }, -"views": { +"encryptionSpec": { "methods": { -"create": { -"description": "Creates a view.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/views", +"initialize": { +"description": "Initializes a location-level encryption key specification. An error will result if the location has resources already created before the initialization. After the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", "httpMethod": "POST", -"id": "contactcenterinsights.projects.locations.views.create", +"id": "contactcenterinsights.projects.locations.encryptionSpec.initialize", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The parent resource of the view. Required. The location to create a view for. Format: `projects//locations/` or `projects//locations/`", +"name": { +"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/views", +"path": "v1/{+name}:initialize", "request": { -"$ref": "GoogleCloudContactcenterinsightsV1View" +"$ref": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest" }, "response": { -"$ref": "GoogleCloudContactcenterinsightsV1View" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"delete": { -"description": "Deletes a view.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", -"httpMethod": "DELETE", -"id": "contactcenterinsights.projects.locations.views.delete", +"insightsdata": { +"methods": { +"export": { +"description": "Export insights data to a destination defined in the request body.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/insightsdata:export", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.insightsdata.export", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "Required. The name of the view to delete.", +"parent": { +"description": "Required. The parent resource to export data from.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}", +"path": "v1/{+parent}/insightsdata:export", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest" +}, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"get": { -"description": "Gets a view.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", +"issueModels": { +"methods": { +"calculateIssueModelStats": { +"description": "Gets an issue model's statistics.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:calculateIssueModelStats", "httpMethod": "GET", -"id": "contactcenterinsights.projects.locations.views.get", +"id": "contactcenterinsights.projects.locations.issueModels.calculateIssueModelStats", "parameterOrder": [ -"name" +"issueModel" ], "parameters": { -"name": { -"description": "Required. The name of the view to get.", +"issueModel": { +"description": "Required. The resource name of the issue model to query against.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}", +"path": "v1/{+issueModel}:calculateIssueModelStats", "response": { -"$ref": "GoogleCloudContactcenterinsightsV1View" +"$ref": "GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"list": { -"description": "Lists views.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/views", -"httpMethod": "GET", -"id": "contactcenterinsights.projects.locations.views.list", +"create": { +"description": "Creates an issue model.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.issueModels.create", "parameterOrder": [ "parent" ], "parameters": { -"pageSize": { -"description": "The maximum number of views to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The value returned by the last `ListViewsResponse`; indicates that this is a continuation of a prior `ListViews` call and the system should return the next page of data.", -"location": "query", -"type": "string" -}, "parent": { -"description": "Required. The parent resource of the views.", +"description": "Required. The parent resource of the issue model.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/views", +"path": "v1/{+parent}/issueModels", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1IssueModel" +}, "response": { -"$ref": "GoogleCloudContactcenterinsightsV1ListViewsResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"patch": { -"description": "Updates a view.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", -"httpMethod": "PATCH", -"id": "contactcenterinsights.projects.locations.views.patch", +"delete": { +"description": "Deletes an issue model.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", +"httpMethod": "DELETE", +"id": "contactcenterinsights.projects.locations.issueModels.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Immutable. The resource name of the view. Format: projects/{project}/locations/{location}/views/{view}", +"description": "Required. The name of the issue model to delete.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "required": true, "type": "string" -}, -"updateMask": { -"description": "The list of fields to be updated.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, "path": "v1/{+name}", -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1View" -}, "response": { -"$ref": "GoogleCloudContactcenterinsightsV1View" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"deploy": { +"description": "Deploys an issue model. Returns an error if a model is already deployed. An issue model can only be used in analysis after it has been deployed.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:deploy", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.issueModels.deploy", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The issue model to deploy.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:deploy", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"export": { +"description": "Exports an issue model to the provided destination.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:export", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.issueModels.export", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The issue model to export.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:export", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets an issue model.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.issueModels.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the issue model to get.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1IssueModel" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"import": { +"description": "Imports an issue model from a Cloud Storage bucket.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels:import", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.issueModels.import", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource of the issue model.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/issueModels:import", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists issue models.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.issueModels.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource of the issue model.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/issueModels", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1ListIssueModelsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates an issue model.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", +"httpMethod": "PATCH", +"id": "contactcenterinsights.projects.locations.issueModels.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "The list of fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1IssueModel" +}, +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1IssueModel" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"undeploy": { +"description": "Undeploys an issue model. An issue model can not be used in analysis after it has been undeployed.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:undeploy", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.issueModels.undeploy", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The issue model to undeploy.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:undeploy", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"issues": { +"methods": { +"delete": { +"description": "Deletes an issue.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", +"httpMethod": "DELETE", +"id": "contactcenterinsights.projects.locations.issueModels.issues.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the issue to delete.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets an issue.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.issueModels.issues.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the issue to get.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1Issue" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists issues.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.issueModels.issues.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource of the issue.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/issues", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1ListIssuesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates an issue.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", +"httpMethod": "PATCH", +"id": "contactcenterinsights.projects.locations.issueModels.issues.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "The list of fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1Issue" +}, +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1Issue" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"phraseMatchers": { +"methods": { +"create": { +"description": "Creates a phrase matcher.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.phraseMatchers.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource of the phrase matcher. Required. The location to create a phrase matcher for. Format: `projects//locations/` or `projects//locations/`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/phraseMatchers", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatcher" +}, +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatcher" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a phrase matcher.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", +"httpMethod": "DELETE", +"id": "contactcenterinsights.projects.locations.phraseMatchers.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the phrase matcher to delete.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a phrase matcher.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.phraseMatchers.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the phrase matcher to get.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatcher" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists phrase matchers.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.phraseMatchers.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "A filter to reduce results to a specific subset. Useful for querying phrase matchers with specific properties.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of phrase matchers to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The value returned by the last `ListPhraseMatchersResponse`. This value indicates that this is a continuation of a prior `ListPhraseMatchers` call and that the system should return the next page of data.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource of the phrase matcher.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/phraseMatchers", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a phrase matcher.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", +"httpMethod": "PATCH", +"id": "contactcenterinsights.projects.locations.phraseMatchers.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "The list of fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatcher" +}, +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatcher" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"qaScorecards": { +"methods": { +"create": { +"description": "Create a QaScorecard.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.qaScorecards.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource of the QaScorecard.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"qaScorecardId": { +"description": "Optional. A unique ID for the new QaScorecard. This ID will become the final component of the QaScorecard's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/qaScorecards", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1QaScorecard" +}, +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1QaScorecard" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a QaScorecard.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}", +"httpMethod": "DELETE", +"id": "contactcenterinsights.projects.locations.qaScorecards.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"force": { +"description": "Optional. If set to true, all of this QaScorecard's child resources will also be deleted. Otherwise, the request will only succeed if it has none.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. The name of the QaScorecard to delete.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a QaScorecard.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.qaScorecards.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the QaScorecard to get.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1QaScorecard" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists QaScorecards.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.qaScorecards.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of scorecards to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The value returned by the last `ListQaScorecardsResponse`. This value indicates that this is a continuation of a prior `ListQaScorecards` call and that the system should return the next page of data.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource of the scorecards.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/qaScorecards", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a QaScorecard.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}", +"httpMethod": "PATCH", +"id": "contactcenterinsights.projects.locations.qaScorecards.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `description` * `display_name`", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1QaScorecard" +}, +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1QaScorecard" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"revisions": { +"methods": { +"create": { +"description": "Creates a QaScorecardRevision.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.qaScorecards.revisions.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource of the QaScorecardRevision.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", +"required": true, +"type": "string" +}, +"qaScorecardRevisionId": { +"description": "Optional. A unique ID for the new QaScorecardRevision. This ID will become the final component of the QaScorecardRevision's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/revisions", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1QaScorecardRevision" +}, +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1QaScorecardRevision" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a QaScorecardRevision.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}", +"httpMethod": "DELETE", +"id": "contactcenterinsights.projects.locations.qaScorecards.revisions.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"force": { +"description": "Optional. If set to true, all of this QaScorecardRevision's child resources will also be deleted. Otherwise, the request will only succeed if it has none.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. The name of the QaScorecardRevision to delete.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"deploy": { +"description": "Deploy a QaScorecardRevision.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:deploy", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.qaScorecards.revisions.deploy", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the QaScorecardRevision to deploy.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:deploy", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1DeployQaScorecardRevisionRequest" +}, +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1QaScorecardRevision" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a QaScorecardRevision.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.qaScorecards.revisions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the QaScorecardRevision to get.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1QaScorecardRevision" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists all revisions under the parent QaScorecard.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.qaScorecards.revisions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter to reduce results to a specific subset. Useful for querying scorecard revisions with specific properties.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of scorecard revisions to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The value returned by the last `ListQaScorecardRevisionsResponse`. This value indicates that this is a continuation of a prior `ListQaScorecardRevisions` call and that the system should return the next page of data.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource of the scorecard revisions. To list all revisions of all scorecards, substitute the QaScorecard ID with a '-' character.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/revisions", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1ListQaScorecardRevisionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"tuneQaScorecardRevision": { +"description": "Fine tune one or more QaModels.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:tuneQaScorecardRevision", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.qaScorecards.revisions.tuneQaScorecardRevision", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource for new fine tuning job instance.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}:tuneQaScorecardRevision", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"undeploy": { +"description": "Undeploy a QaScorecardRevision.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:undeploy", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.qaScorecards.revisions.undeploy", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the QaScorecardRevision to undeploy.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:undeploy", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1UndeployQaScorecardRevisionRequest" +}, +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1QaScorecardRevision" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"qaQuestions": { +"methods": { +"create": { +"description": "Create a QaQuestion.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource of the QaQuestion.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", +"required": true, +"type": "string" +}, +"qaQuestionId": { +"description": "Optional. A unique ID for the new question. This ID will become the final component of the question's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/qaQuestions", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1QaQuestion" +}, +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1QaQuestion" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a QaQuestion.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", +"httpMethod": "DELETE", +"id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the QaQuestion to delete.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a QaQuestion.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the QaQuestion to get.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1QaQuestion" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists QaQuestions.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of questions to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The value returned by the last `ListQaQuestionsResponse`. This value indicates that this is a continuation of a prior `ListQaQuestions` call and that the system should return the next page of data.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource of the questions.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/qaQuestions", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1ListQaQuestionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a QaQuestion.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", +"httpMethod": "PATCH", +"id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `abbreviation` * `answer_choices` * `answer_instructions` * `order` * `question_body` * `tags`", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1QaQuestion" +}, +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1QaQuestion" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +}, +"views": { +"methods": { +"create": { +"description": "Creates a view.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/views", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.views.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource of the view. Required. The location to create a view for. Format: `projects//locations/` or `projects//locations/`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/views", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1View" +}, +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1View" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a view.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", +"httpMethod": "DELETE", +"id": "contactcenterinsights.projects.locations.views.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the view to delete.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a view.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.views.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the view to get.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1View" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists views.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/views", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.views.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "The maximum number of views to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The value returned by the last `ListViewsResponse`; indicates that this is a continuation of a prior `ListViews` call and the system should return the next page of data.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource of the views.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/views", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1ListViewsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a view.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", +"httpMethod": "PATCH", +"id": "contactcenterinsights.projects.locations.views.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The resource name of the view. Format: projects/{project}/locations/{location}/views/{view}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "The list of fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1View" +}, +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1View" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +}, +"revision": "20241021", +"rootUrl": "https://contactcenterinsights.googleapis.com/", +"schemas": { +"GoogleCloudContactcenterinsightsV1Analysis": { +"description": "The analysis resource.", +"id": "GoogleCloudContactcenterinsightsV1Analysis", +"properties": { +"analysisResult": { +"$ref": "GoogleCloudContactcenterinsightsV1AnalysisResult", +"description": "Output only. The result of the analysis, which is populated when the analysis finishes.", +"readOnly": true +}, +"annotatorSelector": { +"$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", +"description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." +}, +"createTime": { +"description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", +"type": "string" +}, +"requestTime": { +"description": "Output only. The time at which the analysis was requested.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1AnalysisResult": { +"description": "The result of an analysis.", +"id": "GoogleCloudContactcenterinsightsV1AnalysisResult", +"properties": { +"callAnalysisMetadata": { +"$ref": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata", +"description": "Call-specific metadata created by the analysis." +}, +"endTime": { +"description": "The time at which the analysis ended.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata": { +"description": "Call-specific metadata created during analysis.", +"id": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata", +"properties": { +"annotations": { +"description": "A list of call annotations that apply to this call.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1CallAnnotation" +}, +"type": "array" +}, +"entities": { +"additionalProperties": { +"$ref": "GoogleCloudContactcenterinsightsV1Entity" +}, +"description": "All the entities in the call.", +"type": "object" +}, +"intents": { +"additionalProperties": { +"$ref": "GoogleCloudContactcenterinsightsV1Intent" +}, +"description": "All the matched intents in the call.", +"type": "object" +}, +"issueModelResult": { +"$ref": "GoogleCloudContactcenterinsightsV1IssueModelResult", +"description": "Overall conversation-level issue modeling result." +}, +"phraseMatchers": { +"additionalProperties": { +"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchData" +}, +"description": "All the matched phrase matchers in the call.", +"type": "object" +}, +"qaScorecardResults": { +"description": "Results of scoring QaScorecards.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResult" +}, +"type": "array" +}, +"sentiments": { +"description": "Overall conversation-level sentiment for each channel of the call.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment" +}, +"type": "array" +}, +"silence": { +"$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSilence", +"description": "Overall conversation-level silence during the call." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1AnalysisRule": { +"description": "The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.", +"id": "GoogleCloudContactcenterinsightsV1AnalysisRule", +"properties": { +"active": { +"description": "If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.", +"type": "boolean" +}, +"analysisPercentage": { +"description": "Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation.", +"format": "double", +"type": "number" +}, +"annotatorSelector": { +"$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", +"description": "Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO annotators will be run." +}, +"conversationFilter": { +"description": "Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations.", +"type": "string" +}, +"createTime": { +"description": "Output only. The time at which this analysis rule was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Display Name of the analysis rule.", +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}", +"type": "string" +}, +"updateTime": { +"description": "Output only. The most recent time at which this analysis rule was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1AnnotationBoundary": { +"description": "A point in a conversation that marks the start or the end of an annotation.", +"id": "GoogleCloudContactcenterinsightsV1AnnotationBoundary", +"properties": { +"transcriptIndex": { +"description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.", +"format": "int32", +"type": "integer" +}, +"wordIndex": { +"description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1AnnotatorSelector": { +"description": "Selector of all available annotators and phrase matchers to run.", +"id": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", +"properties": { +"issueModels": { +"description": "The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.", +"items": { +"type": "string" +}, +"type": "array" +}, +"phraseMatchers": { +"description": "The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", +"items": { +"type": "string" +}, +"type": "array" +}, +"qaConfig": { +"$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig", +"description": "Configuration for the QA annotator." +}, +"runEntityAnnotator": { +"description": "Whether to run the entity annotator.", +"type": "boolean" +}, +"runIntentAnnotator": { +"description": "Whether to run the intent annotator.", +"type": "boolean" +}, +"runInterruptionAnnotator": { +"description": "Whether to run the interruption annotator.", +"type": "boolean" +}, +"runIssueModelAnnotator": { +"description": "Whether to run the issue model annotator. A model should have already been deployed for this to take effect.", +"type": "boolean" +}, +"runPhraseMatcherAnnotator": { +"description": "Whether to run the active phrase matcher annotator(s).", +"type": "boolean" +}, +"runQaAnnotator": { +"description": "Whether to run the QA annotator.", +"type": "boolean" +}, +"runSentimentAnnotator": { +"description": "Whether to run the sentiment annotator.", +"type": "boolean" +}, +"runSilenceAnnotator": { +"description": "Whether to run the silence annotator.", +"type": "boolean" +}, +"runSummarizationAnnotator": { +"description": "Whether to run the summarization annotator.", +"type": "boolean" +}, +"summarizationConfig": { +"$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig", +"description": "Configuration for the summarization annotator." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig": { +"description": "Configuration for the QA feature.", +"id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig", +"properties": { +"scorecardList": { +"$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList", +"description": "A manual list of scorecards to score." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList": { +"description": "Container for a list of scorecards.", +"id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList", +"properties": { +"qaScorecardRevisions": { +"description": "List of QaScorecardRevisions.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig": { +"description": "Configuration for summarization.", +"id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig", +"properties": { +"conversationProfile": { +"description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", +"type": "string" +}, +"summarizationModel": { +"description": "Default summarization model to be used.", +"enum": [ +"SUMMARIZATION_MODEL_UNSPECIFIED", +"BASELINE_MODEL", +"BASELINE_MODEL_V2_0" +], +"enumDescriptions": [ +"Unspecified summarization model.", +"The CCAI baseline model.", +"The CCAI baseline model, V2.0." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1AnswerFeedback": { +"description": "The feedback that the customer has about a certain answer in the conversation.", +"id": "GoogleCloudContactcenterinsightsV1AnswerFeedback", +"properties": { +"clicked": { +"description": "Indicates whether an answer or item was clicked by the human agent.", +"type": "boolean" +}, +"correctnessLevel": { +"description": "The correctness level of an answer.", +"enum": [ +"CORRECTNESS_LEVEL_UNSPECIFIED", +"NOT_CORRECT", +"PARTIALLY_CORRECT", +"FULLY_CORRECT" +], +"enumDescriptions": [ +"Correctness level unspecified.", +"Answer is totally wrong.", +"Answer is partially correct.", +"Answer is fully correct." +], +"type": "string" +}, +"displayed": { +"description": "Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1ArticleSuggestionData": { +"description": "Agent Assist Article Suggestion data.", +"id": "GoogleCloudContactcenterinsightsV1ArticleSuggestionData", +"properties": { +"confidenceScore": { +"description": "The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", +"format": "float", +"type": "number" +}, +"metadata": { +"additionalProperties": { +"type": "string" +}, +"description": "Map that contains metadata about the Article Suggestion and the document that it originates from.", +"type": "object" +}, +"queryRecord": { +"description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", +"type": "string" +}, +"source": { +"description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", +"type": "string" +}, +"title": { +"description": "Article title.", +"type": "string" +}, +"uri": { +"description": "Article URI.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata": { +"description": "The metadata for a bulk analyze conversations operation.", +"id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata", +"properties": { +"completedAnalysesCount": { +"description": "The number of requested analyses that have completed successfully so far.", +"format": "int32", +"type": "integer" +}, +"createTime": { +"description": "The time the operation was created.", +"format": "google-datetime", +"type": "string" +}, +"endTime": { +"description": "The time the operation finished running.", +"format": "google-datetime", +"type": "string" +}, +"failedAnalysesCount": { +"description": "The number of requested analyses that have failed so far.", +"format": "int32", +"type": "integer" +}, +"partialErrors": { +"description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"readOnly": true, +"type": "array" +}, +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest", +"description": "The original request for bulk analyze." +}, +"totalRequestedAnalysesCount": { +"description": "Total number of analyses requested. Computed by the number of conversations returned by `filter` multiplied by `analysis_percentage` in the request.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest": { +"description": "The request to analyze conversations in bulk.", +"id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest", +"properties": { +"analysisPercentage": { +"description": "Required. Percentage of selected conversation to analyze, between [0, 100].", +"format": "float", +"type": "number" +}, +"annotatorSelector": { +"$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", +"description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." +}, +"filter": { +"description": "Required. Filter used to select the subset of conversations to analyze.", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource to create analyses in.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse": { +"description": "The response for a bulk analyze conversations operation.", +"id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse", +"properties": { +"failedAnalysisCount": { +"description": "Count of failed analyses.", +"format": "int32", +"type": "integer" +}, +"successfulAnalysisCount": { +"description": "Count of successful analyses.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata": { +"description": "The metadata for a bulk delete conversations operation.", +"id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata", +"properties": { +"createTime": { +"description": "The time the operation was created.", +"format": "google-datetime", +"type": "string" +}, +"endTime": { +"description": "The time the operation finished running.", +"format": "google-datetime", +"type": "string" +}, +"partialErrors": { +"description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest", +"description": "The original request for bulk delete." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest": { +"description": "The request to delete conversations in bulk.", +"id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest", +"properties": { +"filter": { +"description": "Filter used to select the subset of conversations to delete.", +"type": "string" +}, +"force": { +"description": "If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.", +"type": "boolean" +}, +"maxDeleteCount": { +"description": "Maximum number of conversations to delete.", +"format": "int32", +"type": "integer" +}, +"parent": { +"description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse": { +"description": "The response for a bulk delete conversations operation.", +"id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata": { +"description": "Metadata for the BulkDownloadFeedbackLabel endpoint.", +"id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata", +"properties": { +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"downloadStats": { +"$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats", +"description": "Output only. Statistics for BulkDownloadFeedbackLabels operation.", +"readOnly": true +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"partialErrors": { +"description": "Partial errors during ingest operation that might cause the operation output to be incomplete.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest", +"description": "Output only. The original request for download.", +"readOnly": true } +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats": { +"description": "Statistics for BulkDownloadFeedbackLabels operation.", +"id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats", +"properties": { +"fileNames": { +"description": "Output only. Full name of the files written to Cloud storage.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"processedObjectCount": { +"description": "The number of objects processed during the download operation.", +"format": "int32", +"type": "integer" +}, +"successfulDownloadCount": { +"description": "The number of new feedback labels downloaded during this operation. Different from \"processed\" because some labels might not be downloaded because an error.", +"format": "int32", +"type": "integer" +}, +"totalFilesWritten": { +"description": "Total number of files written to the provided Cloud Storage bucket.", +"format": "int32", +"type": "integer" } +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest": { +"description": "Request for the BulkDownloadFeedbackLabel endpoint.", +"id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest", +"properties": { +"conversationFilter": { +"description": "Optional. Filter parent conversations to download feedback labels for. When specified, the feedback labels will be downloaded for the conversations that match the filter. If `template_qa_scorecard_id` is set, all the conversations that match the filter will be paired with the questions under the scorecard for labeling.", +"type": "string" +}, +"feedbackLabelType": { +"description": "Optional. The type of feedback labels that will be downloaded.", +"enum": [ +"FEEDBACK_LABEL_TYPE_UNSPECIFIED", +"QUALITY_AI", +"TOPIC_MODELING" +], +"enumDescriptions": [ +"Unspecified format", +"Downloaded file will contain all Quality AI labels from the latest scorecard revision.", +"Downloaded file will contain only Topic Modeling labels." +], +"type": "string" +}, +"filter": { +"description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", +"type": "string" +}, +"gcsDestination": { +"$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination", +"description": "A cloud storage bucket destination." +}, +"maxDownloadCount": { +"description": "Optional. Limits the maximum number of feedback labels that will be downloaded. The first `N` feedback labels will be downloaded.", +"format": "int32", +"type": "integer" +}, +"parent": { +"description": "Required. The parent resource for new feedback labels.", +"type": "string" +}, +"templateQaScorecardId": { +"description": "Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversation_filter and the questions under the scorecard(s). The feedback label `filter` will be ignored.", +"items": { +"type": "string" +}, +"type": "array" } +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination": { +"description": "Google Cloud Storage Object details to write the feedback labels to.", +"id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination", +"properties": { +"addWhitespace": { +"description": "Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format.", +"type": "boolean" +}, +"alwaysPrintEmptyFields": { +"description": "Optional. Always print fields with no presence. This is useful for printing fields that are not set, like implicit 0 value or empty lists/maps. Only applicable for JSON format.", +"type": "boolean" +}, +"format": { +"description": "Required. File format in which the labels will be exported.", +"enum": [ +"FORMAT_UNSPECIFIED", +"CSV", +"JSON" +], +"enumDescriptions": [ +"Unspecified format.", +"CSV format. 1,000 labels are stored per CSV file by default.", +"JSON format. 1 label stored per JSON file by default." +], +"type": "string" +}, +"objectUri": { +"description": "Required. The Google Cloud Storage URI to write the feedback labels to. The file name will be used as a prefix for the files written to the bucket if the output needs to be split across multiple files, otherwise it will be used as is. The file extension will be appended to the file name based on the format selected. E.g. `gs://bucket_name/object_uri_prefix`", +"type": "string" +}, +"recordsPerFileCount": { +"description": "Optional. The number of records per file. Applicable for either format.", +"format": "int64", +"type": "string" } +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse": { +"description": "Response for the BulkDownloadFeedbackLabel endpoint.", +"id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest": { +"description": "The request for bulk uploading feedback labels.", +"id": "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest", +"properties": { +"gcsSource": { +"$ref": "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestGcsSource", +"description": "A cloud storage bucket source." +}, +"validateOnly": { +"description": "Optional. If set, upload will not happen and the labels will be validated. If not set, then default behavior will be to upload the labels after validation is complete.", +"type": "boolean" } +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestGcsSource": { +"description": "Google Cloud Storage Object details to get the feedback label file from.", +"id": "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestGcsSource", +"properties": { +"format": { +"description": "Required. File format which will be ingested.", +"enum": [ +"FORMAT_UNSPECIFIED", +"CSV", +"JSON" +], +"enumDescriptions": [ +"Unspecified format.", +"CSV format.", +"JSON format." +], +"type": "string" +}, +"objectUri": { +"description": "Required. The Google Cloud Storage URI of the file to import. Format: `gs://bucket_name/object_name`", +"type": "string" } +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse": { +"description": "Response of querying an issue model's statistics.", +"id": "GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse", +"properties": { +"currentStats": { +"$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats", +"description": "The latest label statistics for the queried issue model. Includes results on both training data and data labeled after deployment." } }, -"revision": "20241008", -"rootUrl": "https://contactcenterinsights.googleapis.com/", -"schemas": { -"GoogleCloudContactcenterinsightsV1Analysis": { -"description": "The analysis resource.", -"id": "GoogleCloudContactcenterinsightsV1Analysis", +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1CalculateStatsResponse": { +"description": "The response for calculating conversation statistics.", +"id": "GoogleCloudContactcenterinsightsV1CalculateStatsResponse", "properties": { -"analysisResult": { -"$ref": "GoogleCloudContactcenterinsightsV1AnalysisResult", -"description": "Output only. The result of the analysis, which is populated when the analysis finishes.", -"readOnly": true +"averageDuration": { +"description": "The average duration of all conversations. The average is calculated using only conversations that have a time duration.", +"format": "google-duration", +"type": "string" +}, +"averageTurnCount": { +"description": "The average number of turns per conversation.", +"format": "int32", +"type": "integer" +}, +"conversationCount": { +"description": "The total number of conversations.", +"format": "int32", +"type": "integer" +}, +"conversationCountTimeSeries": { +"$ref": "GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries", +"description": "A time series representing the count of conversations created over time that match that requested filter criteria." +}, +"customHighlighterMatches": { +"additionalProperties": { +"format": "int32", +"type": "integer" +}, +"description": "A map associating each custom highlighter resource name with its respective number of matches in the set of conversations.", +"type": "object" +}, +"issueMatches": { +"additionalProperties": { +"format": "int32", +"type": "integer" +}, +"deprecated": true, +"description": "A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: `projects//locations//issueModels//issues/` Deprecated, use `issue_matches_stats` field instead.", +"type": "object" +}, +"issueMatchesStats": { +"additionalProperties": { +"$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats" +}, +"description": "A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: `projects//locations//issueModels//issues/`", +"type": "object" +}, +"smartHighlighterMatches": { +"additionalProperties": { +"format": "int32", +"type": "integer" +}, +"description": "A map associating each smart highlighter display name with its respective number of matches in the set of conversations.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries": { +"description": "A time series representing conversations over time.", +"id": "GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries", +"properties": { +"intervalDuration": { +"description": "The duration of each interval.", +"format": "google-duration", +"type": "string" +}, +"points": { +"description": "An ordered list of intervals from earliest to latest, where each interval represents the number of conversations that transpired during the time window.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval": { +"description": "A single interval in a time series.", +"id": "GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval", +"properties": { +"conversationCount": { +"description": "The number of conversations created in this interval.", +"format": "int32", +"type": "integer" +}, +"startTime": { +"description": "The start time of this interval.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1CallAnnotation": { +"description": "A piece of metadata that applies to a window of a call.", +"id": "GoogleCloudContactcenterinsightsV1CallAnnotation", +"properties": { +"annotationEndBoundary": { +"$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary", +"description": "The boundary in the conversation where the annotation ends, inclusive." +}, +"annotationStartBoundary": { +"$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary", +"description": "The boundary in the conversation where the annotation starts, inclusive." +}, +"channelTag": { +"description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.", +"format": "int32", +"type": "integer" +}, +"entityMentionData": { +"$ref": "GoogleCloudContactcenterinsightsV1EntityMentionData", +"description": "Data specifying an entity mention." +}, +"holdData": { +"$ref": "GoogleCloudContactcenterinsightsV1HoldData", +"description": "Data specifying a hold." +}, +"intentMatchData": { +"$ref": "GoogleCloudContactcenterinsightsV1IntentMatchData", +"description": "Data specifying an intent match." +}, +"interruptionData": { +"$ref": "GoogleCloudContactcenterinsightsV1InterruptionData", +"description": "Data specifying an interruption." +}, +"issueMatchData": { +"$ref": "GoogleCloudContactcenterinsightsV1IssueMatchData", +"description": "Data specifying an issue match." +}, +"phraseMatchData": { +"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchData", +"description": "Data specifying a phrase match." +}, +"sentimentData": { +"$ref": "GoogleCloudContactcenterinsightsV1SentimentData", +"description": "Data specifying sentiment." +}, +"silenceData": { +"$ref": "GoogleCloudContactcenterinsightsV1SilenceData", +"description": "Data specifying silence." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1Conversation": { +"description": "The conversation resource.", +"id": "GoogleCloudContactcenterinsightsV1Conversation", +"properties": { +"agentId": { +"description": "An opaque, user-specified string representing the human agent who handled the conversation.", +"type": "string" }, -"annotatorSelector": { -"$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", -"description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." +"callMetadata": { +"$ref": "GoogleCloudContactcenterinsightsV1ConversationCallMetadata", +"description": "Call-specific metadata." }, "createTime": { -"description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", +"description": "Output only. The time at which the conversation was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, -"name": { -"description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", -"type": "string" +"dataSource": { +"$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSource", +"description": "The source of the audio and transcription for the conversation." }, -"requestTime": { -"description": "Output only. The time at which the analysis was requested.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} +"dialogflowIntents": { +"additionalProperties": { +"$ref": "GoogleCloudContactcenterinsightsV1DialogflowIntent" }, +"description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}", +"readOnly": true, "type": "object" }, -"GoogleCloudContactcenterinsightsV1AnalysisResult": { -"description": "The result of an analysis.", -"id": "GoogleCloudContactcenterinsightsV1AnalysisResult", -"properties": { -"callAnalysisMetadata": { -"$ref": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata", -"description": "Call-specific metadata created by the analysis." +"duration": { +"description": "Output only. The duration of the conversation.", +"format": "google-duration", +"readOnly": true, +"type": "string" }, -"endTime": { -"description": "The time at which the analysis ended.", +"expireTime": { +"description": "The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.", "format": "google-datetime", "type": "string" -} }, -"type": "object" +"labels": { +"additionalProperties": { +"type": "string" }, -"GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata": { -"description": "Call-specific metadata created during analysis.", -"id": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata", -"properties": { -"annotations": { -"description": "A list of call annotations that apply to this call.", -"items": { -"$ref": "GoogleCloudContactcenterinsightsV1CallAnnotation" +"description": "A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry.", +"type": "object" }, -"type": "array" +"languageCode": { +"description": "A user-specified language code for the conversation.", +"type": "string" }, -"entities": { -"additionalProperties": { -"$ref": "GoogleCloudContactcenterinsightsV1Entity" +"latestAnalysis": { +"$ref": "GoogleCloudContactcenterinsightsV1Analysis", +"description": "Output only. The conversation's latest analysis, if one exists.", +"readOnly": true }, -"description": "All the entities in the call.", -"type": "object" +"latestSummary": { +"$ref": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData", +"description": "Output only. Latest summary of the conversation.", +"readOnly": true }, -"intents": { -"additionalProperties": { -"$ref": "GoogleCloudContactcenterinsightsV1Intent" +"medium": { +"description": "Immutable. The conversation medium, if unspecified will default to PHONE_CALL.", +"enum": [ +"MEDIUM_UNSPECIFIED", +"PHONE_CALL", +"CHAT" +], +"enumDescriptions": [ +"Default value, if unspecified will default to PHONE_CALL.", +"The format for conversations that took place over the phone.", +"The format for conversations that took place over chat." +], +"type": "string" }, -"description": "All the matched intents in the call.", -"type": "object" +"metadataJson": { +"description": "Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.", +"type": "string" }, -"issueModelResult": { -"$ref": "GoogleCloudContactcenterinsightsV1IssueModelResult", -"description": "Overall conversation-level issue modeling result." +"name": { +"description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", +"type": "string" }, -"phraseMatchers": { -"additionalProperties": { -"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchData" +"obfuscatedUserId": { +"description": "Obfuscated user ID which the customer sent to us.", +"type": "string" }, -"description": "All the matched phrase matchers in the call.", -"type": "object" +"qualityMetadata": { +"$ref": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata", +"description": "Conversation metadata related to quality management." }, -"sentiments": { -"description": "Overall conversation-level sentiment for each channel of the call.", +"runtimeAnnotations": { +"description": "Output only. The annotations that were generated during the customer and agent interaction.", "items": { -"$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment" +"$ref": "GoogleCloudContactcenterinsightsV1RuntimeAnnotation" }, +"readOnly": true, "type": "array" }, -"silence": { -"$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSilence", -"description": "Overall conversation-level silence during the call." +"startTime": { +"description": "The time at which the conversation started.", +"format": "google-datetime", +"type": "string" +}, +"transcript": { +"$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscript", +"description": "Output only. The conversation transcript.", +"readOnly": true +}, +"ttl": { +"description": "Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.", +"format": "google-duration", +"type": "string" +}, +"turnCount": { +"description": "Output only. The number of turns in the conversation.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"updateTime": { +"description": "Output only. The most recent time at which the conversation was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1AnnotationBoundary": { -"description": "A point in a conversation that marks the start or the end of an annotation.", -"id": "GoogleCloudContactcenterinsightsV1AnnotationBoundary", +"GoogleCloudContactcenterinsightsV1ConversationCallMetadata": { +"description": "Call-specific metadata.", +"id": "GoogleCloudContactcenterinsightsV1ConversationCallMetadata", "properties": { -"transcriptIndex": { -"description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.", +"agentChannel": { +"description": "The audio channel that contains the agent.", "format": "int32", "type": "integer" }, -"wordIndex": { -"description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.", +"customerChannel": { +"description": "The audio channel that contains the customer.", "format": "int32", "type": "integer" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1AnnotatorSelector": { -"description": "Selector of all available annotators and phrase matchers to run.", -"id": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", +"GoogleCloudContactcenterinsightsV1ConversationDataSource": { +"description": "The conversation source, which is a combination of transcript and audio.", +"id": "GoogleCloudContactcenterinsightsV1ConversationDataSource", "properties": { -"issueModels": { -"description": "The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.", -"items": { -"type": "string" +"dialogflowSource": { +"$ref": "GoogleCloudContactcenterinsightsV1DialogflowSource", +"description": "The source when the conversation comes from Dialogflow." }, -"type": "array" +"gcsSource": { +"$ref": "GoogleCloudContactcenterinsightsV1GcsSource", +"description": "A Cloud Storage location specification for the audio and transcript." +} }, -"phraseMatchers": { -"description": "The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", -"items": { -"type": "string" +"type": "object" }, -"type": "array" +"GoogleCloudContactcenterinsightsV1ConversationLevelSentiment": { +"description": "One channel of conversation-level sentiment data.", +"id": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment", +"properties": { +"channelTag": { +"description": "The channel of the audio that the data applies to.", +"format": "int32", +"type": "integer" }, -"runEntityAnnotator": { -"description": "Whether to run the entity annotator.", -"type": "boolean" +"sentimentData": { +"$ref": "GoogleCloudContactcenterinsightsV1SentimentData", +"description": "Data specifying sentiment." +} }, -"runIntentAnnotator": { -"description": "Whether to run the intent annotator.", -"type": "boolean" +"type": "object" }, -"runInterruptionAnnotator": { -"description": "Whether to run the interruption annotator.", -"type": "boolean" +"GoogleCloudContactcenterinsightsV1ConversationLevelSilence": { +"description": "Conversation-level silence data.", +"id": "GoogleCloudContactcenterinsightsV1ConversationLevelSilence", +"properties": { +"silenceDuration": { +"description": "Amount of time calculated to be in silence.", +"format": "google-duration", +"type": "string" }, -"runIssueModelAnnotator": { -"description": "Whether to run the issue model annotator. A model should have already been deployed for this to take effect.", -"type": "boolean" +"silencePercentage": { +"description": "Percentage of the total conversation spent in silence.", +"format": "float", +"type": "number" +} }, -"runPhraseMatcherAnnotator": { -"description": "Whether to run the active phrase matcher annotator(s).", -"type": "boolean" +"type": "object" }, -"runSentimentAnnotator": { -"description": "Whether to run the sentiment annotator.", -"type": "boolean" +"GoogleCloudContactcenterinsightsV1ConversationParticipant": { +"description": "The call participant speaking for a given utterance.", +"id": "GoogleCloudContactcenterinsightsV1ConversationParticipant", +"properties": { +"dialogflowParticipant": { +"deprecated": true, +"description": "Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", +"type": "string" }, -"runSilenceAnnotator": { -"description": "Whether to run the silence annotator.", -"type": "boolean" +"dialogflowParticipantName": { +"description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", +"type": "string" }, -"runSummarizationAnnotator": { -"description": "Whether to run the summarization annotator.", -"type": "boolean" +"obfuscatedExternalUserId": { +"description": "Obfuscated user ID from Dialogflow.", +"type": "string" +}, +"role": { +"description": "The role of the participant.", +"enum": [ +"ROLE_UNSPECIFIED", +"HUMAN_AGENT", +"AUTOMATED_AGENT", +"END_USER", +"ANY_AGENT" +], +"enumDescriptions": [ +"Participant's role is not set.", +"Participant is a human agent.", +"Participant is an automated agent.", +"Participant is an end user who conversed with the contact center.", +"Participant is either a human or automated agent." +], +"type": "string" }, -"summarizationConfig": { -"$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig", -"description": "Configuration for the summarization annotator." +"userId": { +"description": "A user-specified ID representing the participant.", +"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig": { -"description": "Configuration for summarization.", -"id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig", +"GoogleCloudContactcenterinsightsV1ConversationQualityMetadata": { +"description": "Conversation metadata related to quality management.", +"id": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata", "properties": { -"conversationProfile": { -"description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", +"agentInfo": { +"description": "Information about agents involved in the call.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo" +}, +"type": "array" +}, +"customerSatisfactionRating": { +"description": "An arbitrary integer value indicating the customer's satisfaction rating.", +"format": "int32", +"type": "integer" +}, +"menuPath": { +"description": "An arbitrary string value specifying the menu path the customer took.", "type": "string" }, -"summarizationModel": { -"description": "Default summarization model to be used.", -"enum": [ -"SUMMARIZATION_MODEL_UNSPECIFIED", -"BASELINE_MODEL", -"BASELINE_MODEL_V2_0" -], -"enumDescriptions": [ -"Unspecified summarization model.", -"The CCAI baseline model.", -"The CCAI baseline model, V2.0." -], +"waitDuration": { +"description": "The amount of time the customer waited to connect with an agent.", +"format": "google-duration", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1AnswerFeedback": { -"description": "The feedback that the customer has about a certain answer in the conversation.", -"id": "GoogleCloudContactcenterinsightsV1AnswerFeedback", +"GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo": { +"description": "Information about an agent involved in the conversation.", +"id": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo", "properties": { -"clicked": { -"description": "Indicates whether an answer or item was clicked by the human agent.", -"type": "boolean" +"agentId": { +"description": "A user-specified string representing the agent.", +"type": "string" }, -"correctnessLevel": { -"description": "The correctness level of an answer.", -"enum": [ -"CORRECTNESS_LEVEL_UNSPECIFIED", -"NOT_CORRECT", -"PARTIALLY_CORRECT", -"FULLY_CORRECT" -], -"enumDescriptions": [ -"Correctness level unspecified.", -"Answer is totally wrong.", -"Answer is partially correct.", -"Answer is fully correct." -], +"displayName": { +"description": "The agent's name.", "type": "string" }, -"displayed": { -"description": "Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.", -"type": "boolean" +"dispositionCode": { +"description": "A user-provided string indicating the outcome of the agent's segment of the call.", +"type": "string" +}, +"team": { +"description": "A user-specified string representing the agent's team.", +"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ArticleSuggestionData": { -"description": "Agent Assist Article Suggestion data.", -"id": "GoogleCloudContactcenterinsightsV1ArticleSuggestionData", +"GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData": { +"description": "Conversation summarization suggestion data.", +"id": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData", "properties": { -"confidenceScore": { -"description": "The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", +"answerRecord": { +"description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", +"type": "string" +}, +"confidence": { +"description": "The confidence score of the summarization.", "format": "float", "type": "number" }, +"conversationModel": { +"description": "The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}", +"type": "string" +}, "metadata": { "additionalProperties": { "type": "string" }, -"description": "Map that contains metadata about the Article Suggestion and the document that it originates from.", +"description": "A map that contains metadata about the summarization and the document from which it originates.", "type": "object" }, -"queryRecord": { -"description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", +"text": { +"description": "The summarization content that is concatenated into one string.", "type": "string" }, -"source": { -"description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", +"textSections": { +"additionalProperties": { "type": "string" }, -"title": { -"description": "Article title.", -"type": "string" +"description": "The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.", +"type": "object" +} }, -"uri": { -"description": "Article URI.", -"type": "string" +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1ConversationTranscript": { +"description": "A message representing the transcript of a conversation.", +"id": "GoogleCloudContactcenterinsightsV1ConversationTranscript", +"properties": { +"transcriptSegments": { +"description": "A list of sequential transcript segments that comprise the conversation.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata": { -"description": "The metadata for a bulk analyze conversations operation.", -"id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata", +"GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment": { +"description": "A segment of a full transcript.", +"id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment", "properties": { -"completedAnalysesCount": { -"description": "The number of requested analyses that have completed successfully so far.", +"channelTag": { +"description": "For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono.", "format": "int32", "type": "integer" }, -"createTime": { -"description": "The time the operation was created.", -"format": "google-datetime", +"confidence": { +"description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.", +"format": "float", +"type": "number" +}, +"dialogflowSegmentMetadata": { +"$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", +"description": "CCAI metadata relating to the current transcript segment." +}, +"languageCode": { +"description": "The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\".", "type": "string" }, -"endTime": { -"description": "The time the operation finished running.", +"messageTime": { +"description": "The time that the message occurred, if provided.", "format": "google-datetime", "type": "string" }, -"failedAnalysesCount": { -"description": "The number of requested analyses that have failed so far.", -"format": "int32", -"type": "integer" +"segmentParticipant": { +"$ref": "GoogleCloudContactcenterinsightsV1ConversationParticipant", +"description": "The participant of this segment." }, -"partialErrors": { -"description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", +"sentiment": { +"$ref": "GoogleCloudContactcenterinsightsV1SentimentData", +"description": "The sentiment for this transcript segment." +}, +"text": { +"description": "The text of this segment.", +"type": "string" +}, +"words": { +"description": "A list of the word-specific information for each word in the segment.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo" }, -"readOnly": true, "type": "array" +} }, -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest", -"description": "The original request for bulk analyze." +"type": "object" }, -"totalRequestedAnalysesCount": { -"description": "Total number of analyses requested. Computed by the number of conversations returned by `filter` multiplied by `analysis_percentage` in the request.", -"format": "int32", -"type": "integer" +"GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { +"description": "Metadata from Dialogflow relating to the current transcript segment.", +"id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", +"properties": { +"smartReplyAllowlistCovered": { +"description": "Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest": { -"description": "The request to analyze conversations in bulk.", -"id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest", +"GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo": { +"description": "Word-level info for words in a transcript.", +"id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo", "properties": { -"analysisPercentage": { -"description": "Required. Percentage of selected conversation to analyze, between [0, 100].", +"confidence": { +"description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.", "format": "float", "type": "number" }, -"annotatorSelector": { -"$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", -"description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." +"endOffset": { +"description": "Time offset of the end of this word relative to the beginning of the total conversation.", +"format": "google-duration", +"type": "string" }, -"filter": { -"description": "Required. Filter used to select the subset of conversations to analyze.", +"startOffset": { +"description": "Time offset of the start of this word relative to the beginning of the total conversation.", +"format": "google-duration", "type": "string" }, -"parent": { -"description": "Required. The parent resource to create analyses in.", +"word": { +"description": "The word itself. Includes punctuation marks that surround the word.", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse": { -"description": "The response for a bulk analyze conversations operation.", -"id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse", +"GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata": { +"description": "Metadata for a create analysis operation.", +"id": "GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata", "properties": { -"failedAnalysisCount": { -"description": "Count of failed analyses.", -"format": "int32", -"type": "integer" +"annotatorSelector": { +"$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", +"description": "Output only. The annotator selector used for the analysis (if any).", +"readOnly": true +}, +"conversation": { +"description": "Output only. The Conversation that this Analysis Operation belongs to.", +"readOnly": true, +"type": "string" }, -"successfulAnalysisCount": { -"description": "Count of successful analyses.", -"format": "int32", -"type": "integer" +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata": { -"description": "The metadata for a bulk delete conversations operation.", -"id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata", +"GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata": { +"description": "Metadata for creating an issue model.", +"id": "GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata", "properties": { "createTime": { -"description": "The time the operation was created.", +"description": "Output only. The time the operation was created.", "format": "google-datetime", +"readOnly": true, "type": "string" }, "endTime": { -"description": "The time the operation finished running.", +"description": "Output only. The time the operation finished running.", "format": "google-datetime", +"readOnly": true, "type": "string" }, -"partialErrors": { -"description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -}, "request": { -"$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest", -"description": "The original request for bulk delete." +"$ref": "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest", +"description": "The original request for creation." } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest": { -"description": "The request to delete conversations in bulk.", -"id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest", +"GoogleCloudContactcenterinsightsV1CreateIssueModelRequest": { +"description": "The request to create an issue model.", +"id": "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest", "properties": { -"filter": { -"description": "Filter used to select the subset of conversations to delete.", -"type": "string" -}, -"force": { -"description": "If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.", -"type": "boolean" -}, -"maxDeleteCount": { -"description": "Maximum number of conversations to delete.", -"format": "int32", -"type": "integer" +"issueModel": { +"$ref": "GoogleCloudContactcenterinsightsV1IssueModel", +"description": "Required. The issue model to create." }, "parent": { -"description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", +"description": "Required. The parent resource of the issue model.", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse": { -"description": "The response for a bulk delete conversations operation.", -"id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse": { -"description": "Response of querying an issue model's statistics.", -"id": "GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse", +"GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata": { +"description": "Metadata for deleting an issue model.", +"id": "GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata", "properties": { -"currentStats": { -"$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats", -"description": "The latest label statistics for the queried issue model. Includes results on both training data and data labeled after deployment." +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest", +"description": "The original request for deletion." } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1CalculateStatsResponse": { -"description": "The response for calculating conversation statistics.", -"id": "GoogleCloudContactcenterinsightsV1CalculateStatsResponse", +"GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest": { +"description": "The request to delete an issue model.", +"id": "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest", "properties": { -"averageDuration": { -"description": "The average duration of all conversations. The average is calculated using only conversations that have a time duration.", -"format": "google-duration", +"name": { +"description": "Required. The name of the issue model to delete.", "type": "string" +} }, -"averageTurnCount": { -"description": "The average number of turns per conversation.", -"format": "int32", -"type": "integer" -}, -"conversationCount": { -"description": "The total number of conversations.", -"format": "int32", -"type": "integer" -}, -"conversationCountTimeSeries": { -"$ref": "GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries", -"description": "A time series representing the count of conversations created over time that match that requested filter criteria." +"type": "object" }, -"customHighlighterMatches": { -"additionalProperties": { -"format": "int32", -"type": "integer" +"GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata": { +"description": "Metadata for deploying an issue model.", +"id": "GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata", +"properties": { +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" }, -"description": "A map associating each custom highlighter resource name with its respective number of matches in the set of conversations.", -"type": "object" +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" }, -"issueMatches": { -"additionalProperties": { -"format": "int32", -"type": "integer" +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest", +"description": "The original request for deployment." +} }, -"deprecated": true, -"description": "A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: `projects//locations//issueModels//issues/` Deprecated, use `issue_matches_stats` field instead.", "type": "object" }, -"issueMatchesStats": { -"additionalProperties": { -"$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats" +"GoogleCloudContactcenterinsightsV1DeployIssueModelRequest": { +"description": "The request to deploy an issue model.", +"id": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest", +"properties": { +"name": { +"description": "Required. The issue model to deploy.", +"type": "string" +} }, -"description": "A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: `projects//locations//issueModels//issues/`", "type": "object" }, -"smartHighlighterMatches": { -"additionalProperties": { -"format": "int32", -"type": "integer" -}, -"description": "A map associating each smart highlighter display name with its respective number of matches in the set of conversations.", +"GoogleCloudContactcenterinsightsV1DeployIssueModelResponse": { +"description": "The response to deploy an issue model.", +"id": "GoogleCloudContactcenterinsightsV1DeployIssueModelResponse", +"properties": {}, "type": "object" -} }, +"GoogleCloudContactcenterinsightsV1DeployQaScorecardRevisionRequest": { +"description": "The request to deploy a QaScorecardRevision", +"id": "GoogleCloudContactcenterinsightsV1DeployQaScorecardRevisionRequest", +"properties": {}, "type": "object" }, -"GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries": { -"description": "A time series representing conversations over time.", -"id": "GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries", +"GoogleCloudContactcenterinsightsV1DialogflowIntent": { +"description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.", +"id": "GoogleCloudContactcenterinsightsV1DialogflowIntent", "properties": { -"intervalDuration": { -"description": "The duration of each interval.", -"format": "google-duration", +"displayName": { +"description": "The human-readable name of the intent.", "type": "string" -}, -"points": { -"description": "An ordered list of intervals from earliest to latest, where each interval represents the number of conversations that transpired during the time window.", -"items": { -"$ref": "GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval" -}, -"type": "array" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval": { -"description": "A single interval in a time series.", -"id": "GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval", +"GoogleCloudContactcenterinsightsV1DialogflowInteractionData": { +"description": "Dialogflow interaction data.", +"id": "GoogleCloudContactcenterinsightsV1DialogflowInteractionData", "properties": { -"conversationCount": { -"description": "The number of conversations created in this interval.", -"format": "int32", -"type": "integer" +"confidence": { +"description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", +"format": "float", +"type": "number" }, -"startTime": { -"description": "The start time of this interval.", -"format": "google-datetime", +"dialogflowIntentId": { +"description": "The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1CallAnnotation": { -"description": "A piece of metadata that applies to a window of a call.", -"id": "GoogleCloudContactcenterinsightsV1CallAnnotation", +"GoogleCloudContactcenterinsightsV1DialogflowSource": { +"description": "A Dialogflow source of conversation data.", +"id": "GoogleCloudContactcenterinsightsV1DialogflowSource", "properties": { -"annotationEndBoundary": { -"$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary", -"description": "The boundary in the conversation where the annotation ends, inclusive." -}, -"annotationStartBoundary": { -"$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary", -"description": "The boundary in the conversation where the annotation starts, inclusive." -}, -"channelTag": { -"description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.", -"format": "int32", -"type": "integer" -}, -"entityMentionData": { -"$ref": "GoogleCloudContactcenterinsightsV1EntityMentionData", -"description": "Data specifying an entity mention." -}, -"holdData": { -"$ref": "GoogleCloudContactcenterinsightsV1HoldData", -"description": "Data specifying a hold." +"audioUri": { +"description": "Cloud Storage URI that points to a file that contains the conversation audio.", +"type": "string" }, -"intentMatchData": { -"$ref": "GoogleCloudContactcenterinsightsV1IntentMatchData", -"description": "Data specifying an intent match." +"dialogflowConversation": { +"description": "Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}", +"readOnly": true, +"type": "string" +} }, -"interruptionData": { -"$ref": "GoogleCloudContactcenterinsightsV1InterruptionData", -"description": "Data specifying an interruption." +"type": "object" }, -"issueMatchData": { -"$ref": "GoogleCloudContactcenterinsightsV1IssueMatchData", -"description": "Data specifying an issue match." +"GoogleCloudContactcenterinsightsV1Dimension": { +"description": "A dimension determines the grouping key for the query. In SQL terms, these would be part of both the \"SELECT\" and \"GROUP BY\" clauses.", +"id": "GoogleCloudContactcenterinsightsV1Dimension", +"properties": { +"agentDimensionMetadata": { +"$ref": "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata", +"description": "Output only. Metadata about the agent dimension.", +"readOnly": true }, -"phraseMatchData": { -"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchData", -"description": "Data specifying a phrase match." +"dimensionKey": { +"description": "The key of the dimension.", +"enum": [ +"DIMENSION_KEY_UNSPECIFIED", +"ISSUE", +"AGENT", +"AGENT_TEAM", +"QA_QUESTION_ID", +"QA_QUESTION_ANSWER_VALUE", +"CONVERSATION_PROFILE_ID" +], +"enumDescriptions": [ +"The key of the dimension is unspecified.", +"The dimension is keyed by issues.", +"The dimension is keyed by agents.", +"The dimension is keyed by agent teams.", +"The dimension is keyed by QaQuestionIds. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing stats for the same question across different scorecard revisions.", +"The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", +"The dimension is keyed by the conversation profile ID." +], +"type": "string" }, -"sentimentData": { -"$ref": "GoogleCloudContactcenterinsightsV1SentimentData", -"description": "Data specifying sentiment." +"issueDimensionMetadata": { +"$ref": "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata", +"description": "Output only. Metadata about the issue dimension.", +"readOnly": true }, -"silenceData": { -"$ref": "GoogleCloudContactcenterinsightsV1SilenceData", -"description": "Data specifying silence." +"qaQuestionAnswerDimensionMetadata": { +"$ref": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata", +"description": "Output only. Metadata about the QA question-answer dimension.", +"readOnly": true +}, +"qaQuestionDimensionMetadata": { +"$ref": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata", +"description": "Output only. Metadata about the QA question dimension.", +"readOnly": true } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1Conversation": { -"description": "The conversation resource.", -"id": "GoogleCloudContactcenterinsightsV1Conversation", +"GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata": { +"description": "Metadata about the agent dimension.", +"id": "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata", "properties": { -"agentId": { -"description": "An opaque, user-specified string representing the human agent who handled the conversation.", +"agentDisplayName": { +"description": "Optional. The agent's name", "type": "string" }, -"callMetadata": { -"$ref": "GoogleCloudContactcenterinsightsV1ConversationCallMetadata", -"description": "Call-specific metadata." -}, -"createTime": { -"description": "Output only. The time at which the conversation was created.", -"format": "google-datetime", -"readOnly": true, +"agentId": { +"description": "Optional. A user-specified string representing the agent.", "type": "string" }, -"dataSource": { -"$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSource", -"description": "The source of the audio and transcription for the conversation." -}, -"dialogflowIntents": { -"additionalProperties": { -"$ref": "GoogleCloudContactcenterinsightsV1DialogflowIntent" +"agentTeam": { +"description": "Optional. A user-specified string representing the agent's team.", +"type": "string" +} }, -"description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}", -"readOnly": true, "type": "object" }, -"duration": { -"description": "Output only. The duration of the conversation.", -"format": "google-duration", -"readOnly": true, +"GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata": { +"description": "Metadata about the issue dimension.", +"id": "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata", +"properties": { +"issueDisplayName": { +"description": "The issue display name.", "type": "string" }, -"expireTime": { -"description": "The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.", -"format": "google-datetime", +"issueId": { +"description": "The issue ID.", "type": "string" }, -"labels": { -"additionalProperties": { +"issueModelId": { +"description": "The parent issue model ID.", "type": "string" +} }, -"description": "A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry.", "type": "object" }, -"languageCode": { -"description": "A user-specified language code for the conversation.", +"GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata": { +"description": "Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard.", +"id": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata", +"properties": { +"answerValue": { +"description": "Optional. The full body of the question.", "type": "string" }, -"latestAnalysis": { -"$ref": "GoogleCloudContactcenterinsightsV1Analysis", -"description": "Output only. The conversation's latest analysis, if one exists.", -"readOnly": true -}, -"latestSummary": { -"$ref": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData", -"description": "Output only. Latest summary of the conversation.", -"readOnly": true +"qaQuestionId": { +"description": "Optional. The QA question ID.", +"type": "string" }, -"medium": { -"description": "Immutable. The conversation medium, if unspecified will default to PHONE_CALL.", -"enum": [ -"MEDIUM_UNSPECIFIED", -"PHONE_CALL", -"CHAT" -], -"enumDescriptions": [ -"Default value, if unspecified will default to PHONE_CALL.", -"The format for conversations that took place over the phone.", -"The format for conversations that took place over chat." -], +"qaScorecardId": { +"description": "Optional. The QA scorecard ID.", "type": "string" }, -"metadataJson": { -"description": "Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.", +"questionBody": { +"description": "Optional. The full body of the question.", "type": "string" +} }, -"name": { -"description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata": { +"description": "Metadata about the QA question dimension.", +"id": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata", +"properties": { +"qaQuestionId": { +"description": "Optional. The QA question ID.", "type": "string" }, -"obfuscatedUserId": { -"description": "Obfuscated user ID which the customer sent to us.", +"qaScorecardId": { +"description": "Optional. The QA scorecard ID.", "type": "string" }, -"qualityMetadata": { -"$ref": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata", -"description": "Conversation metadata related to quality management." +"questionBody": { +"description": "Optional. The full body of the question.", +"type": "string" +} }, -"runtimeAnnotations": { -"description": "Output only. The annotations that were generated during the customer and agent interaction.", -"items": { -"$ref": "GoogleCloudContactcenterinsightsV1RuntimeAnnotation" +"type": "object" }, -"readOnly": true, -"type": "array" +"GoogleCloudContactcenterinsightsV1EncryptionSpec": { +"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`).", +"id": "GoogleCloudContactcenterinsightsV1EncryptionSpec", +"properties": { +"kmsKey": { +"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by our default encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", +"type": "string" }, -"startTime": { -"description": "The time at which the conversation started.", -"format": "google-datetime", +"name": { +"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "type": "string" +} }, -"transcript": { -"$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscript", -"description": "Output only. The conversation transcript.", -"readOnly": true +"type": "object" }, -"ttl": { -"description": "Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.", -"format": "google-duration", +"GoogleCloudContactcenterinsightsV1Entity": { +"description": "The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.", +"id": "GoogleCloudContactcenterinsightsV1Entity", +"properties": { +"displayName": { +"description": "The representative name for the entity.", "type": "string" }, -"turnCount": { -"description": "Output only. The number of turns in the conversation.", -"format": "int32", -"readOnly": true, -"type": "integer" +"metadata": { +"additionalProperties": { +"type": "string" }, -"updateTime": { -"description": "Output only. The most recent time at which the conversation was updated.", -"format": "google-datetime", -"readOnly": true, +"description": "Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.", +"type": "object" +}, +"salience": { +"description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.", +"format": "float", +"type": "number" +}, +"sentiment": { +"$ref": "GoogleCloudContactcenterinsightsV1SentimentData", +"description": "The aggregate sentiment expressed for this entity in the conversation." +}, +"type": { +"description": "The entity type.", +"enum": [ +"TYPE_UNSPECIFIED", +"PERSON", +"LOCATION", +"ORGANIZATION", +"EVENT", +"WORK_OF_ART", +"CONSUMER_GOOD", +"OTHER", +"PHONE_NUMBER", +"ADDRESS", +"DATE", +"NUMBER", +"PRICE" +], +"enumDescriptions": [ +"Unspecified.", +"Person.", +"Location.", +"Organization.", +"Event.", +"Artwork.", +"Consumer product.", +"Other types of entities.", +"Phone number. The metadata lists the phone number (formatted according to local convention), plus whichever additional elements appear in the text: * `number` - The actual number, broken down into sections according to local convention. * `national_prefix` - Country code, if detected. * `area_code` - Region or area code, if detected. * `extension` - Phone extension (to be dialed after connection), if detected.", +"Address. The metadata identifies the street number and locality plus whichever additional elements appear in the text: * `street_number` - Street number. * `locality` - City or town. * `street_name` - Street/route name, if detected. * `postal_code` - Postal code, if detected. * `country` - Country, if detected. * `broad_region` - Administrative area, such as the state, if detected. * `narrow_region` - Smaller administrative area, such as county, if detected. * `sublocality` - Used in Asian addresses to demark a district within a city, if detected.", +"Date. The metadata identifies the components of the date: * `year` - Four digit year, if detected. * `month` - Two digit month number, if detected. * `day` - Two digit day number, if detected.", +"Number. The metadata is the number itself.", +"Price. The metadata identifies the `value` and `currency`." +], "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ConversationCallMetadata": { -"description": "Call-specific metadata.", -"id": "GoogleCloudContactcenterinsightsV1ConversationCallMetadata", +"GoogleCloudContactcenterinsightsV1EntityMentionData": { +"description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation.", +"id": "GoogleCloudContactcenterinsightsV1EntityMentionData", "properties": { -"agentChannel": { -"description": "The audio channel that contains the agent.", -"format": "int32", -"type": "integer" +"entityUniqueId": { +"description": "The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.", +"type": "string" }, -"customerChannel": { -"description": "The audio channel that contains the customer.", -"format": "int32", -"type": "integer" +"sentiment": { +"$ref": "GoogleCloudContactcenterinsightsV1SentimentData", +"description": "Sentiment expressed for this mention of the entity." +}, +"type": { +"description": "The type of the entity mention.", +"enum": [ +"MENTION_TYPE_UNSPECIFIED", +"PROPER", +"COMMON" +], +"enumDescriptions": [ +"Unspecified.", +"Proper noun.", +"Common noun (or noun compound)." +], +"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ConversationDataSource": { -"description": "The conversation source, which is a combination of transcript and audio.", -"id": "GoogleCloudContactcenterinsightsV1ConversationDataSource", +"GoogleCloudContactcenterinsightsV1ExactMatchConfig": { +"description": "Exact match configuration.", +"id": "GoogleCloudContactcenterinsightsV1ExactMatchConfig", "properties": { -"dialogflowSource": { -"$ref": "GoogleCloudContactcenterinsightsV1DialogflowSource", -"description": "The source when the conversation comes from Dialogflow." -}, -"gcsSource": { -"$ref": "GoogleCloudContactcenterinsightsV1GcsSource", -"description": "A Cloud Storage location specification for the audio and transcript." +"caseSensitive": { +"description": "Whether to consider case sensitivity when performing an exact match.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ConversationLevelSentiment": { -"description": "One channel of conversation-level sentiment data.", -"id": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment", +"GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata": { +"description": "Metadata for an export insights operation.", +"id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata", "properties": { -"channelTag": { -"description": "The channel of the audio that the data applies to.", -"format": "int32", -"type": "integer" +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" }, -"sentimentData": { -"$ref": "GoogleCloudContactcenterinsightsV1SentimentData", -"description": "Data specifying sentiment." -} +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" }, -"type": "object" +"partialErrors": { +"description": "Partial errors during export operation that might cause the operation output to be incomplete.", +"items": { +"$ref": "GoogleRpcStatus" }, -"GoogleCloudContactcenterinsightsV1ConversationLevelSilence": { -"description": "Conversation-level silence data.", -"id": "GoogleCloudContactcenterinsightsV1ConversationLevelSilence", -"properties": { -"silenceDuration": { -"description": "Amount of time calculated to be in silence.", -"format": "google-duration", -"type": "string" +"type": "array" }, -"silencePercentage": { -"description": "Percentage of the total conversation spent in silence.", -"format": "float", -"type": "number" +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest", +"description": "The original request for export." } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ConversationParticipant": { -"description": "The call participant speaking for a given utterance.", -"id": "GoogleCloudContactcenterinsightsV1ConversationParticipant", +"GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest": { +"description": "The request to export insights.", +"id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest", "properties": { -"dialogflowParticipant": { -"deprecated": true, -"description": "Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", +"bigQueryDestination": { +"$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination", +"description": "Specified if sink is a BigQuery table." +}, +"filter": { +"description": "A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties.", "type": "string" }, -"dialogflowParticipantName": { -"description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", +"kmsKey": { +"description": "A fully qualified KMS key name for BigQuery tables protected by CMEK. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}", "type": "string" }, -"obfuscatedExternalUserId": { -"description": "Obfuscated user ID from Dialogflow.", +"parent": { +"description": "Required. The parent resource to export data from.", "type": "string" }, -"role": { -"description": "The role of the participant.", +"writeDisposition": { +"description": "Options for what to do if the destination table already exists.", "enum": [ -"ROLE_UNSPECIFIED", -"HUMAN_AGENT", -"AUTOMATED_AGENT", -"END_USER", -"ANY_AGENT" +"WRITE_DISPOSITION_UNSPECIFIED", +"WRITE_TRUNCATE", +"WRITE_APPEND" ], "enumDescriptions": [ -"Participant's role is not set.", -"Participant is a human agent.", -"Participant is an automated agent.", -"Participant is an end user who conversed with the contact center.", -"Participant is either a human or automated agent." +"Write disposition is not specified. Defaults to WRITE_TRUNCATE.", +"If the table already exists, BigQuery will overwrite the table data and use the schema from the load.", +"If the table already exists, BigQuery will append data to the table." ], "type": "string" -}, -"userId": { -"description": "A user-specified ID representing the participant.", -"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ConversationQualityMetadata": { -"description": "Conversation metadata related to quality management.", -"id": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata", +"GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination": { +"description": "A BigQuery Table Reference.", +"id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination", "properties": { -"agentInfo": { -"description": "Information about agents involved in the call.", -"items": { -"$ref": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo" -}, -"type": "array" -}, -"customerSatisfactionRating": { -"description": "An arbitrary integer value indicating the customer's satisfaction rating.", -"format": "int32", -"type": "integer" +"dataset": { +"description": "Required. The name of the BigQuery dataset that the snapshot result should be exported to. If this dataset does not exist, the export call returns an INVALID_ARGUMENT error.", +"type": "string" }, -"menuPath": { -"description": "An arbitrary string value specifying the menu path the customer took.", +"projectId": { +"description": "A project ID or number. If specified, then export will attempt to write data to this project instead of the resource project. Otherwise, the resource project will be used.", "type": "string" }, -"waitDuration": { -"description": "The amount of time the customer waited to connect with an agent.", -"format": "google-duration", +"table": { +"description": "The BigQuery table name to which the insights data should be written. If this table does not exist, the export call returns an INVALID_ARGUMENT error.", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo": { -"description": "Information about an agent involved in the conversation.", -"id": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo", +"GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse": { +"description": "Response for an export insights operation.", +"id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata": { +"description": "Metadata used for export issue model.", +"id": "GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata", "properties": { -"agentId": { -"description": "A user-specified string representing the agent.", +"createTime": { +"description": "The time the operation was created.", +"format": "google-datetime", "type": "string" }, -"displayName": { -"description": "The agent's name.", +"endTime": { +"description": "The time the operation finished running.", +"format": "google-datetime", "type": "string" }, -"dispositionCode": { -"description": "A user-provided string indicating the outcome of the agent's segment of the call.", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest", +"description": "The original export request." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1ExportIssueModelRequest": { +"description": "Request to export an issue model.", +"id": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest", +"properties": { +"gcsDestination": { +"$ref": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination", +"description": "Google Cloud Storage URI to export the issue model to." +}, +"name": { +"description": "Required. The issue model to export.", "type": "string" +} }, -"team": { -"description": "A user-specified string representing the agent's team.", +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination": { +"description": "Google Cloud Storage Object URI to save the issue model to.", +"id": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination", +"properties": { +"objectUri": { +"description": "Required. Format: `gs:///`", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData": { -"description": "Conversation summarization suggestion data.", -"id": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData", +"GoogleCloudContactcenterinsightsV1ExportIssueModelResponse": { +"description": "Response from export issue model", +"id": "GoogleCloudContactcenterinsightsV1ExportIssueModelResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1FaqAnswerData": { +"description": "Agent Assist frequently-asked-question answer data.", +"id": "GoogleCloudContactcenterinsightsV1FaqAnswerData", "properties": { -"answerRecord": { -"description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", +"answer": { +"description": "The piece of text from the `source` knowledge base document.", "type": "string" }, -"confidence": { -"description": "The confidence score of the summarization.", +"confidenceScore": { +"description": "The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "format": "float", "type": "number" }, -"conversationModel": { -"description": "The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}", -"type": "string" -}, "metadata": { "additionalProperties": { "type": "string" }, -"description": "A map that contains metadata about the summarization and the document from which it originates.", +"description": "Map that contains metadata about the FAQ answer and the document that it originates from.", "type": "object" }, -"text": { -"description": "The summarization content that is concatenated into one string.", +"queryRecord": { +"description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, -"textSections": { -"additionalProperties": { +"question": { +"description": "The corresponding FAQ question.", "type": "string" }, -"description": "The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.", -"type": "object" +"source": { +"description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", +"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ConversationTranscript": { -"description": "A message representing the transcript of a conversation.", -"id": "GoogleCloudContactcenterinsightsV1ConversationTranscript", +"GoogleCloudContactcenterinsightsV1FeedbackLabel": { +"description": "Represents a conversation, resource, and label provided by the user.", +"id": "GoogleCloudContactcenterinsightsV1FeedbackLabel", "properties": { -"transcriptSegments": { -"description": "A list of sequential transcript segments that comprise the conversation.", -"items": { -"$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment" +"createTime": { +"description": "Output only. Create time of the label.", +"format": "google-datetime", +"readOnly": true, +"type": "string" }, -"type": "array" +"label": { +"description": "String label.", +"type": "string" +}, +"labeledResource": { +"description": "Resource name of the resource to be labeled.", +"type": "string" +}, +"name": { +"description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", +"type": "string" +}, +"qaAnswerLabel": { +"$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue", +"description": "QaAnswer label." +}, +"updateTime": { +"description": "Output only. Update time of the label.", +"format": "google-datetime", +"readOnly": true, +"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment": { -"description": "A segment of a full transcript.", -"id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment", +"GoogleCloudContactcenterinsightsV1GcsSource": { +"description": "A Cloud Storage source of conversation data.", +"id": "GoogleCloudContactcenterinsightsV1GcsSource", "properties": { -"channelTag": { -"description": "For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono.", -"format": "int32", -"type": "integer" +"audioUri": { +"description": "Cloud Storage URI that points to a file that contains the conversation audio.", +"type": "string" }, -"confidence": { -"description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.", -"format": "float", -"type": "number" +"transcriptUri": { +"description": "Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.", +"type": "string" +} }, -"dialogflowSegmentMetadata": { -"$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", -"description": "CCAI metadata relating to the current transcript segment." +"type": "object" }, -"languageCode": { -"description": "The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\".", -"type": "string" +"GoogleCloudContactcenterinsightsV1HoldData": { +"description": "The data for a hold annotation.", +"id": "GoogleCloudContactcenterinsightsV1HoldData", +"properties": {}, +"type": "object" }, -"messageTime": { -"description": "The time that the message occurred, if provided.", +"GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata": { +"description": "Metadata used for import issue model.", +"id": "GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata", +"properties": { +"createTime": { +"description": "The time the operation was created.", "format": "google-datetime", "type": "string" }, -"segmentParticipant": { -"$ref": "GoogleCloudContactcenterinsightsV1ConversationParticipant", -"description": "The participant of this segment." -}, -"sentiment": { -"$ref": "GoogleCloudContactcenterinsightsV1SentimentData", -"description": "The sentiment for this transcript segment." -}, -"text": { -"description": "The text of this segment.", +"endTime": { +"description": "The time the operation finished running.", +"format": "google-datetime", "type": "string" }, -"words": { -"description": "A list of the word-specific information for each word in the segment.", -"items": { -"$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo" -}, -"type": "array" +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest", +"description": "The original import request." } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { -"description": "Metadata from Dialogflow relating to the current transcript segment.", -"id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", +"GoogleCloudContactcenterinsightsV1ImportIssueModelRequest": { +"description": "Request to import an issue model.", +"id": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest", "properties": { -"smartReplyAllowlistCovered": { -"description": "Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.", +"createNewModel": { +"description": "Optional. If set to true, will create an issue model from the imported file with randomly generated IDs for the issue model and corresponding issues. Otherwise, replaces an existing model with the same ID as the file.", "type": "boolean" -} -}, -"type": "object" }, -"GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo": { -"description": "Word-level info for words in a transcript.", -"id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo", -"properties": { -"confidence": { -"description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.", -"format": "float", -"type": "number" +"gcsSource": { +"$ref": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource", +"description": "Google Cloud Storage source message." }, -"endOffset": { -"description": "Time offset of the end of this word relative to the beginning of the total conversation.", -"format": "google-duration", +"parent": { +"description": "Required. The parent resource of the issue model.", "type": "string" +} }, -"startOffset": { -"description": "Time offset of the start of this word relative to the beginning of the total conversation.", -"format": "google-duration", -"type": "string" +"type": "object" }, -"word": { -"description": "The word itself. Includes punctuation marks that surround the word.", +"GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource": { +"description": "Google Cloud Storage Object URI to get the issue model file from.", +"id": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource", +"properties": { +"objectUri": { +"description": "Required. Format: `gs:///`", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata": { -"description": "Metadata for a create analysis operation.", -"id": "GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata", -"properties": { -"annotatorSelector": { -"$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", -"description": "Output only. The annotator selector used for the analysis (if any).", -"readOnly": true -}, -"conversation": { -"description": "Output only. The Conversation that this Analysis Operation belongs to.", -"readOnly": true, -"type": "string" +"GoogleCloudContactcenterinsightsV1ImportIssueModelResponse": { +"description": "Response from import issue model", +"id": "GoogleCloudContactcenterinsightsV1ImportIssueModelResponse", +"properties": {}, +"type": "object" }, +"GoogleCloudContactcenterinsightsV1IngestConversationsMetadata": { +"description": "The metadata for an IngestConversations operation.", +"id": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadata", +"properties": { "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", @@ -2547,85 +5330,182 @@ "format": "google-datetime", "readOnly": true, "type": "string" +}, +"ingestConversationsStats": { +"$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats", +"description": "Output only. Statistics for IngestConversations operation.", +"readOnly": true +}, +"partialErrors": { +"description": "Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"readOnly": true, +"type": "array" +}, +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest", +"description": "Output only. The original request for ingest.", +"readOnly": true } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata": { -"description": "Metadata for creating an issue model.", -"id": "GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata", +"GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats": { +"description": "Statistics for IngestConversations operation.", +"id": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats", "properties": { -"createTime": { -"description": "Output only. The time the operation was created.", -"format": "google-datetime", +"duplicatesSkippedCount": { +"description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested.", +"format": "int32", "readOnly": true, -"type": "string" +"type": "integer" }, -"endTime": { -"description": "Output only. The time the operation finished running.", -"format": "google-datetime", +"failedIngestCount": { +"description": "Output only. The number of objects which were unable to be ingested due to errors. The errors are populated in the partial_errors field.", +"format": "int32", "readOnly": true, -"type": "string" +"type": "integer" }, -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest", -"description": "The original request for creation." +"processedObjectCount": { +"description": "Output only. The number of objects processed during the ingest operation.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"successfulIngestCount": { +"description": "Output only. The number of new conversations added during this ingest operation.", +"format": "int32", +"readOnly": true, +"type": "integer" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1CreateIssueModelRequest": { -"description": "The request to create an issue model.", -"id": "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest", +"GoogleCloudContactcenterinsightsV1IngestConversationsRequest": { +"description": "The request to ingest conversations.", +"id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest", "properties": { -"issueModel": { -"$ref": "GoogleCloudContactcenterinsightsV1IssueModel", -"description": "Required. The issue model to create." +"conversationConfig": { +"$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig", +"description": "Configuration that applies to all conversations." +}, +"gcsSource": { +"$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource", +"description": "A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication." }, "parent": { -"description": "Required. The parent resource of the issue model.", +"description": "Required. The parent resource for new conversations.", "type": "string" +}, +"redactionConfig": { +"$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig", +"description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings." +}, +"sampleSize": { +"description": "Optional. If set, this fields indicates the number of objects to ingest from the Cloud Storage bucket. If empty, the entire bucket will be ingested. Unless they are first deleted, conversations produced through sampling won't be ingested by subsequent ingest requests.", +"format": "int32", +"type": "integer" +}, +"speechConfig": { +"$ref": "GoogleCloudContactcenterinsightsV1SpeechConfig", +"description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings." +}, +"transcriptObjectConfig": { +"$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig", +"description": "Configuration for when `source` contains conversation transcripts." } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata": { -"description": "Metadata for deleting an issue model.", -"id": "GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata", +"GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig": { +"description": "Configuration that applies to all conversations.", +"id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig", "properties": { -"createTime": { -"description": "Output only. The time the operation was created.", -"format": "google-datetime", -"readOnly": true, +"agentChannel": { +"description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", +"format": "int32", +"type": "integer" +}, +"agentId": { +"description": "Optional. An opaque, user-specified string representing a human agent who handled all conversations in the import. Note that this will be overridden if per-conversation metadata is provided through the `metadata_bucket_uri`.", "type": "string" }, -"endTime": { -"description": "Output only. The time the operation finished running.", -"format": "google-datetime", -"readOnly": true, +"customerChannel": { +"description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource": { +"description": "Configuration for Cloud Storage bucket sources.", +"id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource", +"properties": { +"bucketObjectType": { +"description": "Optional. Specifies the type of the objects in `bucket_uri`.", +"enum": [ +"BUCKET_OBJECT_TYPE_UNSPECIFIED", +"TRANSCRIPT", +"AUDIO" +], +"enumDescriptions": [ +"The object type is unspecified and will default to `TRANSCRIPT`.", +"The object is a transcript.", +"The object is an audio file." +], +"type": "string" +}, +"bucketUri": { +"description": "Required. The Cloud Storage bucket containing source objects.", +"type": "string" +}, +"customMetadataKeys": { +"description": "Optional. Custom keys to extract as conversation labels from metadata files in `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a limit of 20 labels per conversation.", +"items": { +"type": "string" +}, +"type": "array" +}, +"metadataBucketUri": { +"description": "Optional. The Cloud Storage path to the conversation metadata. Note that: [1] Metadata files are expected to be in JSON format. [2] Metadata and source files (transcripts or audio) must be in separate buckets. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig": { +"description": "Configuration for processing transcript objects.", +"id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig", +"properties": { +"medium": { +"description": "Required. The medium transcript objects represent.", +"enum": [ +"MEDIUM_UNSPECIFIED", +"PHONE_CALL", +"CHAT" +], +"enumDescriptions": [ +"Default value, if unspecified will default to PHONE_CALL.", +"The format for conversations that took place over the phone.", +"The format for conversations that took place over chat." +], "type": "string" -}, -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest", -"description": "The original request for deletion." } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest": { -"description": "The request to delete an issue model.", -"id": "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest", -"properties": { -"name": { -"description": "Required. The name of the issue model to delete.", -"type": "string" -} -}, +"GoogleCloudContactcenterinsightsV1IngestConversationsResponse": { +"description": "The response to an IngestConversations operation.", +"id": "GoogleCloudContactcenterinsightsV1IngestConversationsResponse", +"properties": {}, "type": "object" }, -"GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata": { -"description": "Metadata for deploying an issue model.", -"id": "GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata", +"GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata": { +"description": "Metadata for initializing a location-level encryption specification.", +"id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", @@ -2639,859 +5519,850 @@ "readOnly": true, "type": "string" }, +"partialErrors": { +"description": "Partial errors during initializing operation that might cause the operation output to be incomplete.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, "request": { -"$ref": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest", -"description": "The original request for deployment." +"$ref": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest", +"description": "Output only. The original request for initialization.", +"readOnly": true } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1DeployIssueModelRequest": { -"description": "The request to deploy an issue model.", -"id": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest", +"GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest": { +"description": "The request to initialize a location-level encryption specification.", +"id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest", "properties": { -"name": { -"description": "Required. The issue model to deploy.", -"type": "string" +"encryptionSpec": { +"$ref": "GoogleCloudContactcenterinsightsV1EncryptionSpec", +"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the `kms_key_name` field is left empty, no encryption will be enforced." } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1DeployIssueModelResponse": { -"description": "The response to deploy an issue model.", -"id": "GoogleCloudContactcenterinsightsV1DeployIssueModelResponse", +"GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse": { +"description": "The response to initialize a location-level encryption specification.", +"id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse", "properties": {}, "type": "object" }, -"GoogleCloudContactcenterinsightsV1DialogflowIntent": { -"description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.", -"id": "GoogleCloudContactcenterinsightsV1DialogflowIntent", +"GoogleCloudContactcenterinsightsV1Intent": { +"description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", +"id": "GoogleCloudContactcenterinsightsV1Intent", "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" +}, +"id": { +"description": "The unique identifier of the intent.", +"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1DialogflowInteractionData": { -"description": "Dialogflow interaction data.", -"id": "GoogleCloudContactcenterinsightsV1DialogflowInteractionData", +"GoogleCloudContactcenterinsightsV1IntentMatchData": { +"description": "The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences.", +"id": "GoogleCloudContactcenterinsightsV1IntentMatchData", "properties": { -"confidence": { -"description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", -"format": "float", -"type": "number" -}, -"dialogflowIntentId": { -"description": "The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}", +"intentUniqueId": { +"description": "The id of the matched intent. Can be used to retrieve the corresponding intent information.", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1DialogflowSource": { -"description": "A Dialogflow source of conversation data.", -"id": "GoogleCloudContactcenterinsightsV1DialogflowSource", +"GoogleCloudContactcenterinsightsV1InterruptionData": { +"description": "The data for an interruption annotation.", +"id": "GoogleCloudContactcenterinsightsV1InterruptionData", +"properties": {}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1Issue": { +"description": "The issue resource.", +"id": "GoogleCloudContactcenterinsightsV1Issue", "properties": { -"audioUri": { -"description": "Cloud Storage URI that points to a file that contains the conversation audio.", +"createTime": { +"description": "Output only. The time at which this issue was created.", +"format": "google-datetime", +"readOnly": true, "type": "string" }, -"dialogflowConversation": { -"description": "Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}", +"displayDescription": { +"description": "Representative description of the issue.", +"type": "string" +}, +"displayName": { +"description": "The representative name for the issue.", +"type": "string" +}, +"name": { +"description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", +"type": "string" +}, +"sampleUtterances": { +"description": "Output only. Resource names of the sample representative utterances that match to this issue.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"updateTime": { +"description": "Output only. The most recent time that this issue was updated.", +"format": "google-datetime", "readOnly": true, "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1EncryptionSpec": { -"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`).", -"id": "GoogleCloudContactcenterinsightsV1EncryptionSpec", +"GoogleCloudContactcenterinsightsV1IssueAssignment": { +"description": "Information about the issue.", +"id": "GoogleCloudContactcenterinsightsV1IssueAssignment", "properties": { -"kmsKey": { -"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by our default encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", +"displayName": { +"description": "Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.", "type": "string" }, -"name": { -"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", +"issue": { +"description": "Resource name of the assigned issue.", "type": "string" +}, +"score": { +"description": "Score indicating the likelihood of the issue assignment. currently bounded on [0,1].", +"format": "double", +"type": "number" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1Entity": { -"description": "The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.", -"id": "GoogleCloudContactcenterinsightsV1Entity", +"GoogleCloudContactcenterinsightsV1IssueMatchData": { +"description": "The data for an issue match annotation.", +"id": "GoogleCloudContactcenterinsightsV1IssueMatchData", "properties": { -"displayName": { -"description": "The representative name for the entity.", +"issueAssignment": { +"$ref": "GoogleCloudContactcenterinsightsV1IssueAssignment", +"description": "Information about the issue's assignment." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1IssueModel": { +"description": "The issue model resource.", +"id": "GoogleCloudContactcenterinsightsV1IssueModel", +"properties": { +"createTime": { +"description": "Output only. The time at which this issue model was created.", +"format": "google-datetime", +"readOnly": true, "type": "string" }, -"metadata": { -"additionalProperties": { +"displayName": { +"description": "The representative name for the issue model.", "type": "string" }, -"description": "Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.", -"type": "object" +"inputDataConfig": { +"$ref": "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig", +"description": "Configs for the input data that used to create the issue model." }, -"salience": { -"description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.", -"format": "float", -"type": "number" +"issueCount": { +"description": "Output only. Number of issues in this issue model.", +"format": "int64", +"readOnly": true, +"type": "string" }, -"sentiment": { -"$ref": "GoogleCloudContactcenterinsightsV1SentimentData", -"description": "The aggregate sentiment expressed for this entity in the conversation." +"languageCode": { +"description": "Language of the model.", +"type": "string" }, -"type": { -"description": "The entity type.", +"modelType": { +"description": "Type of the model.", "enum": [ -"TYPE_UNSPECIFIED", -"PERSON", -"LOCATION", -"ORGANIZATION", -"EVENT", -"WORK_OF_ART", -"CONSUMER_GOOD", -"OTHER", -"PHONE_NUMBER", -"ADDRESS", -"DATE", -"NUMBER", -"PRICE" +"MODEL_TYPE_UNSPECIFIED", +"TYPE_V1", +"TYPE_V2" ], "enumDescriptions": [ -"Unspecified.", -"Person.", -"Location.", -"Organization.", -"Event.", -"Artwork.", -"Consumer product.", -"Other types of entities.", -"Phone number. The metadata lists the phone number (formatted according to local convention), plus whichever additional elements appear in the text: * `number` - The actual number, broken down into sections according to local convention. * `national_prefix` - Country code, if detected. * `area_code` - Region or area code, if detected. * `extension` - Phone extension (to be dialed after connection), if detected.", -"Address. The metadata identifies the street number and locality plus whichever additional elements appear in the text: * `street_number` - Street number. * `locality` - City or town. * `street_name` - Street/route name, if detected. * `postal_code` - Postal code, if detected. * `country` - Country, if detected. * `broad_region` - Administrative area, such as the state, if detected. * `narrow_region` - Smaller administrative area, such as county, if detected. * `sublocality` - Used in Asian addresses to demark a district within a city, if detected.", -"Date. The metadata identifies the components of the date: * `year` - Four digit year, if detected. * `month` - Two digit month number, if detected. * `day` - Two digit day number, if detected.", -"Number. The metadata is the number itself.", -"Price. The metadata identifies the `value` and `currency`." +"Unspecified model type.", +"Type V1.", +"Type V2." ], "type": "string" -} -}, -"type": "object" }, -"GoogleCloudContactcenterinsightsV1EntityMentionData": { -"description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation.", -"id": "GoogleCloudContactcenterinsightsV1EntityMentionData", -"properties": { -"entityUniqueId": { -"description": "The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.", +"name": { +"description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, -"sentiment": { -"$ref": "GoogleCloudContactcenterinsightsV1SentimentData", -"description": "Sentiment expressed for this mention of the entity." -}, -"type": { -"description": "The type of the entity mention.", +"state": { +"description": "Output only. State of the model.", "enum": [ -"MENTION_TYPE_UNSPECIFIED", -"PROPER", -"COMMON" +"STATE_UNSPECIFIED", +"UNDEPLOYED", +"DEPLOYING", +"DEPLOYED", +"UNDEPLOYING", +"DELETING" ], "enumDescriptions": [ "Unspecified.", -"Proper noun.", -"Common noun (or noun compound)." +"Model is not deployed but is ready to deploy.", +"Model is being deployed.", +"Model is deployed and is ready to be used. A model can only be used in analysis if it's in this state.", +"Model is being undeployed.", +"Model is being deleted." ], +"readOnly": true, "type": "string" -} }, -"type": "object" +"trainingStats": { +"$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats", +"description": "Output only. Immutable. The issue model's label statistics on its training data.", +"readOnly": true }, -"GoogleCloudContactcenterinsightsV1ExactMatchConfig": { -"description": "Exact match configuration.", -"id": "GoogleCloudContactcenterinsightsV1ExactMatchConfig", -"properties": { -"caseSensitive": { -"description": "Whether to consider case sensitivity when performing an exact match.", -"type": "boolean" +"updateTime": { +"description": "Output only. The most recent time at which the issue model was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata": { -"description": "Metadata for an export insights operation.", -"id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata", +"GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig": { +"description": "Configs for the input data used to create the issue model.", +"id": "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig", "properties": { -"createTime": { -"description": "Output only. The time the operation was created.", -"format": "google-datetime", -"readOnly": true, +"filter": { +"description": "A filter to reduce the conversations used for training the model to a specific subset.", "type": "string" }, -"endTime": { -"description": "Output only. The time the operation finished running.", -"format": "google-datetime", -"readOnly": true, +"medium": { +"deprecated": true, +"description": "Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`.", +"enum": [ +"MEDIUM_UNSPECIFIED", +"PHONE_CALL", +"CHAT" +], +"enumDescriptions": [ +"Default value, if unspecified will default to PHONE_CALL.", +"The format for conversations that took place over the phone.", +"The format for conversations that took place over chat." +], "type": "string" }, -"partialErrors": { -"description": "Partial errors during export operation that might cause the operation output to be incomplete.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -}, -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest", -"description": "The original request for export." +"trainingConversationsCount": { +"description": "Output only. Number of conversations used in training. Output only.", +"format": "int64", +"readOnly": true, +"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest": { -"description": "The request to export insights.", -"id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest", +"GoogleCloudContactcenterinsightsV1IssueModelLabelStats": { +"description": "Aggregated statistics about an issue model.", +"id": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats", "properties": { -"bigQueryDestination": { -"$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination", -"description": "Specified if sink is a BigQuery table." -}, -"filter": { -"description": "A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties.", +"analyzedConversationsCount": { +"description": "Number of conversations the issue model has analyzed at this point in time.", +"format": "int64", "type": "string" }, -"kmsKey": { -"description": "A fully qualified KMS key name for BigQuery tables protected by CMEK. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}", -"type": "string" +"issueStats": { +"additionalProperties": { +"$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats" }, -"parent": { -"description": "Required. The parent resource to export data from.", -"type": "string" +"description": "Statistics on each issue. Key is the issue's resource name.", +"type": "object" }, -"writeDisposition": { -"description": "Options for what to do if the destination table already exists.", -"enum": [ -"WRITE_DISPOSITION_UNSPECIFIED", -"WRITE_TRUNCATE", -"WRITE_APPEND" -], -"enumDescriptions": [ -"Write disposition is not specified. Defaults to WRITE_TRUNCATE.", -"If the table already exists, BigQuery will overwrite the table data and use the schema from the load.", -"If the table already exists, BigQuery will append data to the table." -], +"unclassifiedConversationsCount": { +"description": "Number of analyzed conversations for which no issue was applicable at this point in time.", +"format": "int64", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination": { -"description": "A BigQuery Table Reference.", -"id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination", +"GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats": { +"description": "Aggregated statistics about an issue.", +"id": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats", "properties": { -"dataset": { -"description": "Required. The name of the BigQuery dataset that the snapshot result should be exported to. If this dataset does not exist, the export call returns an INVALID_ARGUMENT error.", +"displayName": { +"description": "Display name of the issue.", "type": "string" }, -"projectId": { -"description": "A project ID or number. If specified, then export will attempt to write data to this project instead of the resource project. Otherwise, the resource project will be used.", +"issue": { +"description": "Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" }, -"table": { -"description": "The BigQuery table name to which the insights data should be written. If this table does not exist, the export call returns an INVALID_ARGUMENT error.", +"labeledConversationsCount": { +"description": "Number of conversations attached to the issue at this point in time.", +"format": "int64", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse": { -"description": "Response for an export insights operation.", -"id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata": { -"description": "Metadata used for export issue model.", -"id": "GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata", +"GoogleCloudContactcenterinsightsV1IssueModelResult": { +"description": "Issue Modeling result on a conversation.", +"id": "GoogleCloudContactcenterinsightsV1IssueModelResult", "properties": { -"createTime": { -"description": "The time the operation was created.", -"format": "google-datetime", +"issueModel": { +"description": "Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, -"endTime": { -"description": "The time the operation finished running.", -"format": "google-datetime", -"type": "string" +"issues": { +"description": "All the matched issues.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1IssueAssignment" }, -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest", -"description": "The original export request." +"type": "array" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ExportIssueModelRequest": { -"description": "Request to export an issue model.", -"id": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest", +"GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse": { +"description": "The response for listing all feedback labels.", +"id": "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse", "properties": { -"gcsDestination": { -"$ref": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination", -"description": "Google Cloud Storage URI to export the issue model to." +"feedbackLabels": { +"description": "The feedback labels that match the request.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, -"name": { -"description": "Required. The issue model to export.", +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination": { -"description": "Google Cloud Storage Object URI to save the issue model to.", -"id": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination", +"GoogleCloudContactcenterinsightsV1ListAnalysesResponse": { +"description": "The response to list analyses.", +"id": "GoogleCloudContactcenterinsightsV1ListAnalysesResponse", "properties": { -"objectUri": { -"description": "Required. Format: `gs:///`", +"analyses": { +"description": "The analyses that match the request.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1Analysis" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ExportIssueModelResponse": { -"description": "Response from export issue model", -"id": "GoogleCloudContactcenterinsightsV1ExportIssueModelResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudContactcenterinsightsV1FaqAnswerData": { -"description": "Agent Assist frequently-asked-question answer data.", -"id": "GoogleCloudContactcenterinsightsV1FaqAnswerData", +"GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse": { +"description": "The response of listing views.", +"id": "GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse", "properties": { -"answer": { -"description": "The piece of text from the `source` knowledge base document.", -"type": "string" +"analysisRules": { +"description": "The analysis_rule that match the request.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1AnalysisRule" }, -"confidenceScore": { -"description": "The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", -"format": "float", -"type": "number" +"type": "array" }, -"metadata": { -"additionalProperties": { +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" +} }, -"description": "Map that contains metadata about the FAQ answer and the document that it originates from.", "type": "object" }, -"queryRecord": { -"description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", -"type": "string" +"GoogleCloudContactcenterinsightsV1ListConversationsResponse": { +"description": "The response of listing conversations.", +"id": "GoogleCloudContactcenterinsightsV1ListConversationsResponse", +"properties": { +"conversations": { +"description": "The conversations that match the request.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, -"question": { -"description": "The corresponding FAQ question.", -"type": "string" +"type": "array" }, -"source": { -"description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", +"nextPageToken": { +"description": "A token which can be sent as `page_token` to retrieve the next page. If this field is set, it means there is another page available. If it is not set, it means no other pages are available.", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1GcsSource": { -"description": "A Cloud Storage source of conversation data.", -"id": "GoogleCloudContactcenterinsightsV1GcsSource", +"GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse": { +"description": "The response for listing feedback labels.", +"id": "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse", "properties": { -"audioUri": { -"description": "Cloud Storage URI that points to a file that contains the conversation audio.", -"type": "string" +"feedbackLabels": { +"description": "The feedback labels that match the request.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, -"transcriptUri": { -"description": "Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.", +"type": "array" +}, +"nextPageToken": { +"description": "The next page token.", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1HoldData": { -"description": "The data for a hold annotation.", -"id": "GoogleCloudContactcenterinsightsV1HoldData", -"properties": {}, +"GoogleCloudContactcenterinsightsV1ListIssueModelsResponse": { +"description": "The response of listing issue models.", +"id": "GoogleCloudContactcenterinsightsV1ListIssueModelsResponse", +"properties": { +"issueModels": { +"description": "The issue models that match the request.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1IssueModel" +}, +"type": "array" +} +}, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata": { -"description": "Metadata used for import issue model.", -"id": "GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata", +"GoogleCloudContactcenterinsightsV1ListIssuesResponse": { +"description": "The response of listing issues.", +"id": "GoogleCloudContactcenterinsightsV1ListIssuesResponse", "properties": { -"createTime": { -"description": "The time the operation was created.", -"format": "google-datetime", -"type": "string" -}, -"endTime": { -"description": "The time the operation finished running.", -"format": "google-datetime", -"type": "string" +"issues": { +"description": "The issues that match the request.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1Issue" }, -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest", -"description": "The original import request." +"type": "array" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ImportIssueModelRequest": { -"description": "Request to import an issue model.", -"id": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest", +"GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse": { +"description": "The response of listing phrase matchers.", +"id": "GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse", "properties": { -"createNewModel": { -"description": "Optional. If set to true, will create an issue model from the imported file with randomly generated IDs for the issue model and corresponding issues. Otherwise, replaces an existing model with the same ID as the file.", -"type": "boolean" +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" }, -"gcsSource": { -"$ref": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource", -"description": "Google Cloud Storage source message." +"phraseMatchers": { +"description": "The phrase matchers that match the request.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatcher" }, -"parent": { -"description": "Required. The parent resource of the issue model.", -"type": "string" +"type": "array" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource": { -"description": "Google Cloud Storage Object URI to get the issue model file from.", -"id": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource", +"GoogleCloudContactcenterinsightsV1ListQaQuestionsResponse": { +"description": "The response from a ListQaQuestions request.", +"id": "GoogleCloudContactcenterinsightsV1ListQaQuestionsResponse", "properties": { -"objectUri": { -"description": "Required. Format: `gs:///`", +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" -} }, -"type": "object" +"qaQuestions": { +"description": "The QaQuestions under the parent.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1QaQuestion" +}, +"type": "array" +} }, -"GoogleCloudContactcenterinsightsV1ImportIssueModelResponse": { -"description": "Response from import issue model", -"id": "GoogleCloudContactcenterinsightsV1ImportIssueModelResponse", -"properties": {}, "type": "object" }, -"GoogleCloudContactcenterinsightsV1IngestConversationsMetadata": { -"description": "The metadata for an IngestConversations operation.", -"id": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadata", +"GoogleCloudContactcenterinsightsV1ListQaScorecardRevisionsResponse": { +"description": "The response from a ListQaScorecardRevisions request.", +"id": "GoogleCloudContactcenterinsightsV1ListQaScorecardRevisionsResponse", "properties": { -"createTime": { -"description": "Output only. The time the operation was created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"endTime": { -"description": "Output only. The time the operation finished running.", -"format": "google-datetime", -"readOnly": true, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, -"ingestConversationsStats": { -"$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats", -"description": "Output only. Statistics for IngestConversations operation.", -"readOnly": true -}, -"partialErrors": { -"description": "Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.", +"qaScorecardRevisions": { +"description": "The QaScorecards under the parent.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudContactcenterinsightsV1QaScorecardRevision" }, -"readOnly": true, "type": "array" -}, -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest", -"description": "Output only. The original request for ingest.", -"readOnly": true } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats": { -"description": "Statistics for IngestConversations operation.", -"id": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats", +"GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse": { +"description": "The response from a ListQaScorecards request.", +"id": "GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse", "properties": { -"duplicatesSkippedCount": { -"description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested.", -"format": "int32", -"readOnly": true, -"type": "integer" -}, -"failedIngestCount": { -"description": "Output only. The number of objects which were unable to be ingested due to errors. The errors are populated in the partial_errors field.", -"format": "int32", -"readOnly": true, -"type": "integer" +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" }, -"processedObjectCount": { -"description": "Output only. The number of objects processed during the ingest operation.", -"format": "int32", -"readOnly": true, -"type": "integer" +"qaScorecards": { +"description": "The QaScorecards under the parent.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1QaScorecard" }, -"successfulIngestCount": { -"description": "Output only. The number of new conversations added during this ingest operation.", -"format": "int32", -"readOnly": true, -"type": "integer" +"type": "array" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1IngestConversationsRequest": { -"description": "The request to ingest conversations.", -"id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest", +"GoogleCloudContactcenterinsightsV1ListViewsResponse": { +"description": "The response of listing views.", +"id": "GoogleCloudContactcenterinsightsV1ListViewsResponse", "properties": { -"conversationConfig": { -"$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig", -"description": "Configuration that applies to all conversations." -}, -"gcsSource": { -"$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource", -"description": "A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication." -}, -"parent": { -"description": "Required. The parent resource for new conversations.", +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, -"redactionConfig": { -"$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig", -"description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings." -}, -"sampleSize": { -"description": "Optional. If set, this fields indicates the number of objects to ingest from the Cloud Storage bucket. If empty, the entire bucket will be ingested. Unless they are first deleted, conversations produced through sampling won't be ingested by subsequent ingest requests.", -"format": "int32", -"type": "integer" -}, -"speechConfig": { -"$ref": "GoogleCloudContactcenterinsightsV1SpeechConfig", -"description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings." +"views": { +"description": "The views that match the request.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1View" }, -"transcriptObjectConfig": { -"$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig", -"description": "Configuration for when `source` contains conversation transcripts." +"type": "array" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig": { -"description": "Configuration that applies to all conversations.", -"id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig", +"GoogleCloudContactcenterinsightsV1PhraseMatchData": { +"description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", +"id": "GoogleCloudContactcenterinsightsV1PhraseMatchData", "properties": { -"agentChannel": { -"description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", -"format": "int32", -"type": "integer" -}, -"agentId": { -"description": "Optional. An opaque, user-specified string representing a human agent who handled all conversations in the import. Note that this will be overridden if per-conversation metadata is provided through the `metadata_bucket_uri`.", +"displayName": { +"description": "The human-readable name of the phrase matcher.", "type": "string" }, -"customerChannel": { -"description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", -"format": "int32", -"type": "integer" +"phraseMatcher": { +"description": "The unique identifier (the resource name) of the phrase matcher.", +"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource": { -"description": "Configuration for Cloud Storage bucket sources.", -"id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource", +"GoogleCloudContactcenterinsightsV1PhraseMatchRule": { +"description": "The data for a phrase match rule.", +"id": "GoogleCloudContactcenterinsightsV1PhraseMatchRule", "properties": { -"bucketObjectType": { -"description": "Optional. Specifies the type of the objects in `bucket_uri`.", -"enum": [ -"BUCKET_OBJECT_TYPE_UNSPECIFIED", -"TRANSCRIPT", -"AUDIO" -], -"enumDescriptions": [ -"The object type is unspecified and will default to `TRANSCRIPT`.", -"The object is a transcript.", -"The object is an audio file." -], -"type": "string" +"config": { +"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig", +"description": "Provides additional information about the rule that specifies how to apply the rule." }, -"bucketUri": { -"description": "Required. The Cloud Storage bucket containing source objects.", -"type": "string" +"negated": { +"description": "Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.", +"type": "boolean" }, -"customMetadataKeys": { -"description": "Optional. Custom keys to extract as conversation labels from metadata files in `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a limit of 20 labels per conversation.", -"items": { +"query": { +"description": "Required. The phrase to be matched.", "type": "string" +} }, -"type": "array" +"type": "object" }, -"metadataBucketUri": { -"description": "Optional. The Cloud Storage path to the conversation metadata. Note that: [1] Metadata files are expected to be in JSON format. [2] Metadata and source files (transcripts or audio) must be in separate buckets. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.", -"type": "string" +"GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig": { +"description": "Configuration information of a phrase match rule.", +"id": "GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig", +"properties": { +"exactMatchConfig": { +"$ref": "GoogleCloudContactcenterinsightsV1ExactMatchConfig", +"description": "The configuration for the exact match rule." } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig": { -"description": "Configuration for processing transcript objects.", -"id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig", +"GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup": { +"description": "A message representing a rule in the phrase matcher.", +"id": "GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup", "properties": { -"medium": { -"description": "Required. The medium transcript objects represent.", +"phraseMatchRules": { +"description": "A list of phrase match rules that are included in this group.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchRule" +}, +"type": "array" +}, +"type": { +"description": "Required. The type of this phrase match rule group.", "enum": [ -"MEDIUM_UNSPECIFIED", -"PHONE_CALL", -"CHAT" +"PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED", +"ALL_OF", +"ANY_OF" ], "enumDescriptions": [ -"Default value, if unspecified will default to PHONE_CALL.", -"The format for conversations that took place over the phone.", -"The format for conversations that took place over chat." +"Unspecified.", +"Must meet all phrase match rules or there is no match.", +"If any of the phrase match rules are met, there is a match." ], "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1IngestConversationsResponse": { -"description": "The response to an IngestConversations operation.", -"id": "GoogleCloudContactcenterinsightsV1IngestConversationsResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata": { -"description": "Metadata for initializing a location-level encryption specification.", -"id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata", +"GoogleCloudContactcenterinsightsV1PhraseMatcher": { +"description": "The phrase matcher resource.", +"id": "GoogleCloudContactcenterinsightsV1PhraseMatcher", "properties": { -"createTime": { -"description": "Output only. The time the operation was created.", +"activationUpdateTime": { +"description": "Output only. The most recent time at which the activation status was updated.", "format": "google-datetime", "readOnly": true, "type": "string" }, -"endTime": { -"description": "Output only. The time the operation finished running.", -"format": "google-datetime", -"readOnly": true, +"active": { +"description": "Applies the phrase matcher only when it is active.", +"type": "boolean" +}, +"displayName": { +"description": "The human-readable name of the phrase matcher.", "type": "string" }, -"partialErrors": { -"description": "Partial errors during initializing operation that might cause the operation output to be incomplete.", +"name": { +"description": "The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", +"type": "string" +}, +"phraseMatchRuleGroups": { +"description": "A list of phase match rule groups that are included in this matcher.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup" }, "type": "array" }, -"request": { -"$ref": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest", -"description": "Output only. The original request for initialization.", -"readOnly": true -} -}, -"type": "object" +"revisionCreateTime": { +"description": "Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.", +"format": "google-datetime", +"readOnly": true, +"type": "string" }, -"GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest": { -"description": "The request to initialize a location-level encryption specification.", -"id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest", -"properties": { -"encryptionSpec": { -"$ref": "GoogleCloudContactcenterinsightsV1EncryptionSpec", -"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the `kms_key_name` field is left empty, no encryption will be enforced." -} +"revisionId": { +"description": "Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567", +"readOnly": true, +"type": "string" }, -"type": "object" +"roleMatch": { +"description": "The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.", +"enum": [ +"ROLE_UNSPECIFIED", +"HUMAN_AGENT", +"AUTOMATED_AGENT", +"END_USER", +"ANY_AGENT" +], +"enumDescriptions": [ +"Participant's role is not set.", +"Participant is a human agent.", +"Participant is an automated agent.", +"Participant is an end user who conversed with the contact center.", +"Participant is either a human or automated agent." +], +"type": "string" }, -"GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse": { -"description": "The response to initialize a location-level encryption specification.", -"id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse", -"properties": {}, -"type": "object" +"type": { +"description": "Required. The type of this phrase matcher.", +"enum": [ +"PHRASE_MATCHER_TYPE_UNSPECIFIED", +"ALL_OF", +"ANY_OF" +], +"enumDescriptions": [ +"Unspecified.", +"Must meet all phrase match rule groups or there is no match.", +"If any of the phrase match rule groups are met, there is a match." +], +"type": "string" }, -"GoogleCloudContactcenterinsightsV1Intent": { -"description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", -"id": "GoogleCloudContactcenterinsightsV1Intent", -"properties": { -"displayName": { -"description": "The human-readable name of the intent.", +"updateTime": { +"description": "Output only. The most recent time at which the phrase matcher was updated.", +"format": "google-datetime", +"readOnly": true, "type": "string" }, -"id": { -"description": "The unique identifier of the intent.", +"versionTag": { +"description": "The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1IntentMatchData": { -"description": "The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences.", -"id": "GoogleCloudContactcenterinsightsV1IntentMatchData", +"GoogleCloudContactcenterinsightsV1QaAnswer": { +"description": "An answer to a QaQuestion.", +"id": "GoogleCloudContactcenterinsightsV1QaAnswer", "properties": { -"intentUniqueId": { -"description": "The id of the matched intent. Can be used to retrieve the corresponding intent information.", -"type": "string" -} +"answerSources": { +"description": "List of all individual answers given to the question.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource" }, -"type": "object" +"type": "array" }, -"GoogleCloudContactcenterinsightsV1InterruptionData": { -"description": "The data for an interruption annotation.", -"id": "GoogleCloudContactcenterinsightsV1InterruptionData", -"properties": {}, -"type": "object" +"answerValue": { +"$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue", +"description": "The main answer value, incorporating any manual edits if they exist." }, -"GoogleCloudContactcenterinsightsV1Issue": { -"description": "The issue resource.", -"id": "GoogleCloudContactcenterinsightsV1Issue", -"properties": { -"createTime": { -"description": "Output only. The time at which this issue was created.", -"format": "google-datetime", -"readOnly": true, +"conversation": { +"description": "The conversation the answer applies to.", "type": "string" }, -"displayDescription": { -"description": "Representative description of the issue.", -"type": "string" +"potentialScore": { +"deprecated": true, +"description": "The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead.", +"format": "double", +"type": "number" }, -"displayName": { -"description": "The representative name for the issue.", +"qaQuestion": { +"description": "The QaQuestion answered by this answer.", "type": "string" }, -"name": { -"description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", +"questionBody": { +"description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, -"sampleUtterances": { -"description": "Output only. Resource names of the sample representative utterances that match to this issue.", +"tags": { +"description": "User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.", "items": { "type": "string" }, -"readOnly": true, "type": "array" +} }, -"updateTime": { -"description": "Output only. The most recent time that this issue was updated.", -"format": "google-datetime", -"readOnly": true, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource": { +"description": "A question may have multiple answers from varying sources, one of which becomes the \"main\" answer above. AnswerSource represents each individual answer.", +"id": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource", +"properties": { +"answerValue": { +"$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue", +"description": "The answer value from this source." +}, +"sourceType": { +"description": "What created the answer.", +"enum": [ +"SOURCE_TYPE_UNSPECIFIED", +"SYSTEM_GENERATED", +"MANUAL_EDIT" +], +"enumDescriptions": [ +"Source type is unspecified.", +"Answer was system-generated; created during an Insights analysis.", +"Answer was created by a human via manual edit." +], "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1IssueAssignment": { -"description": "Information about the issue.", -"id": "GoogleCloudContactcenterinsightsV1IssueAssignment", +"GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue": { +"description": "Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question.", +"id": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue", "properties": { -"displayName": { -"description": "Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.", -"type": "string" +"boolValue": { +"description": "Boolean value.", +"type": "boolean" }, -"issue": { -"description": "Resource name of the assigned issue.", +"key": { +"description": "A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.", "type": "string" }, -"score": { -"description": "Score indicating the likelihood of the issue assignment. currently bounded on [0,1].", +"naValue": { +"description": "A value of \"Not Applicable (N/A)\".", +"type": "boolean" +}, +"normalizedScore": { +"description": "Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0", +"format": "double", +"readOnly": true, +"type": "number" +}, +"numValue": { +"description": "Numerical value.", "format": "double", "type": "number" -} }, -"type": "object" +"potentialScore": { +"description": "Output only. The maximum potential score of the question.", +"format": "double", +"readOnly": true, +"type": "number" }, -"GoogleCloudContactcenterinsightsV1IssueMatchData": { -"description": "The data for an issue match annotation.", -"id": "GoogleCloudContactcenterinsightsV1IssueMatchData", -"properties": { -"issueAssignment": { -"$ref": "GoogleCloudContactcenterinsightsV1IssueAssignment", -"description": "Information about the issue's assignment." +"score": { +"description": "Output only. Numerical score of the answer.", +"format": "double", +"readOnly": true, +"type": "number" +}, +"strValue": { +"description": "String value.", +"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1IssueModel": { -"description": "The issue model resource.", -"id": "GoogleCloudContactcenterinsightsV1IssueModel", +"GoogleCloudContactcenterinsightsV1QaQuestion": { +"description": "A single question to be scored by the Insights QA feature.", +"id": "GoogleCloudContactcenterinsightsV1QaQuestion", "properties": { -"createTime": { -"description": "Output only. The time at which this issue model was created.", -"format": "google-datetime", -"readOnly": true, +"abbreviation": { +"description": "Short, descriptive string, used in the UI where it's not practical to display the full question body. E.g., \"Greeting\".", "type": "string" }, -"displayName": { -"description": "The representative name for the issue model.", -"type": "string" +"answerChoices": { +"description": "A list of valid answers to the question, which the LLM must choose from.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoice" }, -"inputDataConfig": { -"$ref": "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig", -"description": "Configs for the input data that used to create the issue model." +"type": "array" }, -"issueCount": { -"description": "Output only. Number of issues in this issue model.", -"format": "int64", -"readOnly": true, +"answerInstructions": { +"description": "Instructions describing how to determine the answer.", "type": "string" }, -"languageCode": { -"description": "Language of the model.", +"createTime": { +"description": "Output only. The time at which this question was created.", +"format": "google-datetime", +"readOnly": true, "type": "string" }, -"modelType": { -"description": "Type of the model.", -"enum": [ -"MODEL_TYPE_UNSPECIFIED", -"TYPE_V1", -"TYPE_V2" -], -"enumDescriptions": [ -"Unspecified model type.", -"Type V1.", -"Type V2." -], -"type": "string" +"metrics": { +"$ref": "GoogleCloudContactcenterinsightsV1QaQuestionMetrics", +"description": "Metrics of the underlying tuned LLM over a holdout/test set while fine tuning the underlying LLM for the given question. This field will only be populated if and only if the question is part of a scorecard revision that has been tuned." }, "name": { -"description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", +"description": "Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}", "type": "string" }, -"state": { -"description": "Output only. State of the model.", -"enum": [ -"STATE_UNSPECIFIED", -"UNDEPLOYED", -"DEPLOYING", -"DEPLOYED", -"UNDEPLOYING", -"DELETING" -], -"enumDescriptions": [ -"Unspecified.", -"Model is not deployed but is ready to deploy.", -"Model is being deployed.", -"Model is deployed and is ready to be used. A model can only be used in analysis if it's in this state.", -"Model is being undeployed.", -"Model is being deleted." -], -"readOnly": true, +"order": { +"description": "Defines the order of the question within its parent scorecard revision.", +"format": "int32", +"type": "integer" +}, +"questionBody": { +"description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, -"trainingStats": { -"$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats", -"description": "Output only. Immutable. The issue model's label statistics on its training data.", -"readOnly": true +"tags": { +"description": "User-defined list of arbitrary tags for the question. Used for grouping/organization and for weighting the score of each question.", +"items": { +"type": "string" +}, +"type": "array" +}, +"tuningMetadata": { +"$ref": "GoogleCloudContactcenterinsightsV1QaQuestionTuningMetadata", +"description": "Metadata about the tuning operation for the question.This field will only be populated if and only if the question is part of a scorecard revision that has been tuned." }, "updateTime": { -"description": "Output only. The most recent time at which the issue model was updated.", +"description": "Output only. The most recent time at which the question was updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -3499,354 +6370,504 @@ }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig": { -"description": "Configs for the input data used to create the issue model.", -"id": "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig", +"GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoice": { +"description": "Message representing a possible answer to the question.", +"id": "GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoice", "properties": { -"filter": { -"description": "A filter to reduce the conversations used for training the model to a specific subset.", +"boolValue": { +"description": "Boolean value.", +"type": "boolean" +}, +"key": { +"description": "A short string used as an identifier.", "type": "string" }, -"medium": { -"deprecated": true, -"description": "Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`.", -"enum": [ -"MEDIUM_UNSPECIFIED", -"PHONE_CALL", -"CHAT" -], -"enumDescriptions": [ -"Default value, if unspecified will default to PHONE_CALL.", -"The format for conversations that took place over the phone.", -"The format for conversations that took place over chat." -], +"naValue": { +"description": "A value of \"Not Applicable (N/A)\". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations.", +"type": "boolean" +}, +"numValue": { +"description": "Numerical value.", +"format": "double", +"type": "number" +}, +"score": { +"description": "Numerical score of the answer, used for generating the overall score of a QaScorecardResult. If the answer uses na_value, this field is unused.", +"format": "double", +"type": "number" +}, +"strValue": { +"description": "String value.", "type": "string" +} }, -"trainingConversationsCount": { -"description": "Output only. Number of conversations used in training. Output only.", -"format": "int64", +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1QaQuestionMetrics": { +"description": "A wrapper representing metrics calculated against a test-set on a LLM that was fine tuned for this question.", +"id": "GoogleCloudContactcenterinsightsV1QaQuestionMetrics", +"properties": { +"accuracy": { +"description": "Output only. Accuracy of the model. Measures the percentage of correct answers the model gave on the test set.", +"format": "double", "readOnly": true, -"type": "string" +"type": "number" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1IssueModelLabelStats": { -"description": "Aggregated statistics about an issue model.", -"id": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats", +"GoogleCloudContactcenterinsightsV1QaQuestionTuningMetadata": { +"description": "Metadata about the tuning operation for the question. Will only be set if a scorecard containing this question has been tuned.", +"id": "GoogleCloudContactcenterinsightsV1QaQuestionTuningMetadata", "properties": { -"analyzedConversationsCount": { -"description": "Number of conversations the issue model has analyzed at this point in time.", -"format": "int64", +"datasetValidationWarnings": { +"description": "A list of any applicable data validation warnings about the question's feedback labels.", +"items": { +"enum": [ +"DATASET_VALIDATION_WARNING_UNSPECIFIED", +"TOO_MANY_INVALID_FEEDBACK_LABELS", +"INSUFFICIENT_FEEDBACK_LABELS", +"INSUFFICIENT_FEEDBACK_LABELS_PER_ANSWER", +"ALL_FEEDBACK_LABELS_HAVE_THE_SAME_ANSWER" +], +"enumDescriptions": [ +"Unspecified data validation warning.", +"A non-trivial percentage of the feedback labels are invalid.", +"The quantity of valid feedback labels provided is less than the recommended minimum.", +"One or more of the answers have less than the recommended minimum of feedback labels.", +"All the labels in the dataset come from a single answer choice." +], "type": "string" }, -"issueStats": { -"additionalProperties": { -"$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats" -}, -"description": "Statistics on each issue. Key is the issue's resource name.", -"type": "object" +"type": "array" }, -"unclassifiedConversationsCount": { -"description": "Number of analyzed conversations for which no issue was applicable at this point in time.", +"totalValidLabelCount": { +"description": "Total number of valid labels provided for the question at the time of tuining.", "format": "int64", "type": "string" +}, +"tuningError": { +"description": "Error status of the tuning operation for the question. Will only be set if the tuning operation failed.", +"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats": { -"description": "Aggregated statistics about an issue.", -"id": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats", +"GoogleCloudContactcenterinsightsV1QaScorecard": { +"description": "A QaScorecard represents a collection of questions to be scored during analysis.", +"id": "GoogleCloudContactcenterinsightsV1QaScorecard", "properties": { +"createTime": { +"description": "Output only. The time at which this scorecard was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "A text description explaining the intent of the scorecard.", +"type": "string" +}, "displayName": { -"description": "Display name of the issue.", +"description": "The user-specified display name of the scorecard.", "type": "string" }, -"issue": { -"description": "Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", +"name": { +"description": "Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}", "type": "string" }, -"labeledConversationsCount": { -"description": "Number of conversations attached to the issue at this point in time.", -"format": "int64", +"updateTime": { +"description": "Output only. The most recent time at which the scorecard was updated.", +"format": "google-datetime", +"readOnly": true, "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1IssueModelResult": { -"description": "Issue Modeling result on a conversation.", -"id": "GoogleCloudContactcenterinsightsV1IssueModelResult", +"GoogleCloudContactcenterinsightsV1QaScorecardResult": { +"description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.", +"id": "GoogleCloudContactcenterinsightsV1QaScorecardResult", "properties": { -"issueModel": { -"description": "Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", +"agentId": { +"description": "ID of the agent that handled the conversation.", "type": "string" }, -"issues": { -"description": "All the matched issues.", +"conversation": { +"description": "The conversation scored by this result.", +"type": "string" +}, +"createTime": { +"description": "Output only. The timestamp that the revision was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}", +"type": "string" +}, +"normalizedScore": { +"description": "The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.", +"format": "double", +"type": "number" +}, +"potentialScore": { +"description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", +"format": "double", +"type": "number" +}, +"qaAnswers": { +"description": "Set of QaAnswers represented in the result.", "items": { -"$ref": "GoogleCloudContactcenterinsightsV1IssueAssignment" +"$ref": "GoogleCloudContactcenterinsightsV1QaAnswer" }, "type": "array" -} }, -"type": "object" +"qaScorecardRevision": { +"description": "The QaScorecardRevision scored by this result.", +"type": "string" }, -"GoogleCloudContactcenterinsightsV1ListAnalysesResponse": { -"description": "The response to list analyses.", -"id": "GoogleCloudContactcenterinsightsV1ListAnalysesResponse", -"properties": { -"analyses": { -"description": "The analyses that match the request.", +"qaTagResults": { +"description": "Collection of tags and their scores.", "items": { -"$ref": "GoogleCloudContactcenterinsightsV1Analysis" +"$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" }, "type": "array" }, -"nextPageToken": { -"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", -"type": "string" +"score": { +"description": "The overall numerical score of the result, incorporating any manual edits if they exist.", +"format": "double", +"type": "number" +}, +"scoreSources": { +"description": "List of all individual score sets.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ListConversationsResponse": { -"description": "The response of listing conversations.", -"id": "GoogleCloudContactcenterinsightsV1ListConversationsResponse", +"GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult": { +"description": "Tags and their corresponding results.", +"id": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult", "properties": { -"conversations": { -"description": "The conversations that match the request.", -"items": { -"$ref": "GoogleCloudContactcenterinsightsV1Conversation" +"normalizedScore": { +"description": "The normalized score the tag applies to.", +"format": "double", +"type": "number" }, -"type": "array" +"potentialScore": { +"description": "The potential score the tag applies to.", +"format": "double", +"type": "number" }, -"nextPageToken": { -"description": "A token which can be sent as `page_token` to retrieve the next page. If this field is set, it means there is another page available. If it is not set, it means no other pages are available.", +"score": { +"description": "The score the tag applies to.", +"format": "double", +"type": "number" +}, +"tag": { +"description": "The tag the score applies to.", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ListIssueModelsResponse": { -"description": "The response of listing issue models.", -"id": "GoogleCloudContactcenterinsightsV1ListIssueModelsResponse", +"GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource": { +"description": "A scorecard result may have multiple sets of scores from varying sources, one of which becomes the \"main\" answer above. A ScoreSource represents each individual set of scores.", +"id": "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource", "properties": { -"issueModels": { -"description": "The issue models that match the request.", +"normalizedScore": { +"description": "The normalized score, which is the score divided by the potential score.", +"format": "double", +"type": "number" +}, +"potentialScore": { +"description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", +"format": "double", +"type": "number" +}, +"qaTagResults": { +"description": "Collection of tags and their scores.", "items": { -"$ref": "GoogleCloudContactcenterinsightsV1IssueModel" +"$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" }, "type": "array" +}, +"score": { +"description": "The overall numerical score of the result.", +"format": "double", +"type": "number" +}, +"sourceType": { +"description": "What created the score.", +"enum": [ +"SOURCE_TYPE_UNSPECIFIED", +"SYSTEM_GENERATED_ONLY", +"INCLUDES_MANUAL_EDITS" +], +"enumDescriptions": [ +"Source type is unspecified.", +"Score is derived only from system-generated answers.", +"Score is derived from both system-generated answers, and includes any manual edits if they exist." +], +"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ListIssuesResponse": { -"description": "The response of listing issues.", -"id": "GoogleCloudContactcenterinsightsV1ListIssuesResponse", +"GoogleCloudContactcenterinsightsV1QaScorecardRevision": { +"description": "A revision of a QaScorecard. Modifying published scorecard fields would invalidate existing scorecard results \u2014 the questions may have changed, or the score weighting will make existing scores impossible to understand. So changes must create a new revision, rather than modifying the existing resource.", +"id": "GoogleCloudContactcenterinsightsV1QaScorecardRevision", "properties": { -"issues": { -"description": "The issues that match the request.", +"alternateIds": { +"description": "Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.", "items": { -"$ref": "GoogleCloudContactcenterinsightsV1Issue" +"type": "string" }, +"readOnly": true, "type": "array" -} }, -"type": "object" +"createTime": { +"description": "Output only. The timestamp that the revision was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" }, -"GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse": { -"description": "The response of listing phrase matchers.", -"id": "GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse", -"properties": { -"nextPageToken": { -"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"name": { +"description": "Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}", "type": "string" }, -"phraseMatchers": { -"description": "The phrase matchers that match the request.", -"items": { -"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatcher" +"snapshot": { +"$ref": "GoogleCloudContactcenterinsightsV1QaScorecard", +"description": "The snapshot of the scorecard at the time of this revision's creation." }, -"type": "array" +"state": { +"description": "Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis.", +"enum": [ +"STATE_UNSPECIFIED", +"EDITABLE", +"TRAINING", +"TRAINING_FAILED", +"READY", +"DELETING", +"TRAINING_CANCELLED" +], +"enumDescriptions": [ +"Unspecified.", +"The scorecard revision can be edited.", +"Scorecard model training is in progress.", +"Scorecard revision model training failed.", +"The revision can be used in analysis.", +"Scorecard is being deleted.", +"Scorecard model training was explicitly cancelled by the user." +], +"readOnly": true, +"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1ListViewsResponse": { -"description": "The response of listing views.", -"id": "GoogleCloudContactcenterinsightsV1ListViewsResponse", -"properties": { -"nextPageToken": { -"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", -"type": "string" +"GoogleCloudContactcenterinsightsV1QueryMetricsMetadata": { +"description": "The metadata from querying metrics.", +"id": "GoogleCloudContactcenterinsightsV1QueryMetricsMetadata", +"properties": {}, +"type": "object" }, -"views": { -"description": "The views that match the request.", +"GoogleCloudContactcenterinsightsV1QueryMetricsRequest": { +"description": "The request for querying metrics.", +"id": "GoogleCloudContactcenterinsightsV1QueryMetricsRequest", +"properties": { +"dimensions": { +"description": "The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension's key must be unique. If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity. Up to one dimension is supported for now.", "items": { -"$ref": "GoogleCloudContactcenterinsightsV1View" +"$ref": "GoogleCloudContactcenterinsightsV1Dimension" }, "type": "array" -} }, -"type": "object" +"filter": { +"description": "Required. Filter to select a subset of conversations to compute the metrics. Must specify a window of the conversation create time to compute the metrics. The returned metrics will be from the range [DATE(starting create time), DATE(ending create time)). ", +"type": "string" }, -"GoogleCloudContactcenterinsightsV1PhraseMatchData": { -"description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", -"id": "GoogleCloudContactcenterinsightsV1PhraseMatchData", -"properties": { -"displayName": { -"description": "The human-readable name of the phrase matcher.", +"measureMask": { +"description": "Measures to return. Defaults to all measures if this field is unspecified. A valid mask should traverse from the `measure` field from the response. For example, a path from a measure mask to get the conversation count is \"conversation_measure.count\".", +"format": "google-fieldmask", "type": "string" }, -"phraseMatcher": { -"description": "The unique identifier (the resource name) of the phrase matcher.", +"timeGranularity": { +"description": "The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified.", +"enum": [ +"TIME_GRANULARITY_UNSPECIFIED", +"NONE", +"DAILY", +"HOURLY", +"PER_MINUTE", +"PER_5_MINUTES" +], +"enumDescriptions": [ +"The time granularity is unspecified and will default to NONE.", +"No time granularity. The response won't contain a time series. This is the default value if no time granularity is specified.", +"Data points in the time series will aggregate at a daily granularity. 1 day means [midnight to midnight).", +"Data points in the time series will aggregate at a daily granularity. 1 HOUR means [01:00 to 02:00).", +"Data points in the time series will aggregate at a daily granularity. PER_MINUTE means [01:00 to 01:01).", +"Data points in the time series will aggregate at a 1 minute granularity. PER_5_MINUTES means [01:00 to 01:05)." +], "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1PhraseMatchRule": { -"description": "The data for a phrase match rule.", -"id": "GoogleCloudContactcenterinsightsV1PhraseMatchRule", +"GoogleCloudContactcenterinsightsV1QueryMetricsResponse": { +"description": "The response for querying metrics.", +"id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponse", "properties": { -"config": { -"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig", -"description": "Provides additional information about the rule that specifies how to apply the rule." +"location": { +"description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", +"type": "string" }, -"negated": { -"description": "Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.", -"type": "boolean" +"macroAverageSlice": { +"$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice", +"description": "The macro average slice contains aggregated averages across the selected dimension. i.e. if group_by agent is specified this field will contain the average across all agents. This field is only populated if the request specifies a Dimension." +}, +"slices": { +"description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice" }, -"query": { -"description": "Required. The phrase to be matched.", +"type": "array" +}, +"updateTime": { +"description": "The metrics last update time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig": { -"description": "Configuration information of a phrase match rule.", -"id": "GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig", +"GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice": { +"description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request. For example, if the request specifies a single ISSUE dimension and it has a cardinality of 2 (i.e. the data used to compute the metrics has 2 issues in total), the response will have 2 slices: * Slice 1 -> dimensions=[Issue 1] * Slice 2 -> dimensions=[Issue 2]", +"id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice", "properties": { -"exactMatchConfig": { -"$ref": "GoogleCloudContactcenterinsightsV1ExactMatchConfig", -"description": "The configuration for the exact match rule." +"dimensions": { +"description": "A unique combination of dimensions that this slice represents.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1Dimension" +}, +"type": "array" +}, +"timeSeries": { +"$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries", +"description": "A time series of metric values. This is only populated if the request specifies a time granularity other than NONE." +}, +"total": { +"$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint", +"description": "The total metric value. The interval of this data point is [starting create time, ending create time) from the request." } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup": { -"description": "A message representing a rule in the phrase matcher.", -"id": "GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup", +"GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint": { +"description": "A data point contains the metric values mapped to an interval.", +"id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint", "properties": { -"phraseMatchRules": { -"description": "A list of phrase match rules that are included in this group.", -"items": { -"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchRule" -}, -"type": "array" +"conversationMeasure": { +"$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure", +"description": "The measure related to conversations." }, -"type": { -"description": "Required. The type of this phrase match rule group.", -"enum": [ -"PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED", -"ALL_OF", -"ANY_OF" -], -"enumDescriptions": [ -"Unspecified.", -"Must meet all phrase match rules or there is no match.", -"If any of the phrase match rules are met, there is a match." -], -"type": "string" +"interval": { +"$ref": "GoogleTypeInterval", +"description": "The interval that this data point represents. * If this is the total data point, the interval is [starting create time, ending create time) from the request. * If this a data point from the time series, the interval is [time, time + time granularity from the request)." } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1PhraseMatcher": { -"description": "The phrase matcher resource.", -"id": "GoogleCloudContactcenterinsightsV1PhraseMatcher", +"GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure": { +"description": "The measure related to conversations.", +"id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure", "properties": { -"activationUpdateTime": { -"description": "Output only. The most recent time at which the activation status was updated.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"averageAgentSentimentScore": { +"description": "The average agent's sentiment score.", +"format": "float", +"type": "number" }, -"active": { -"description": "Applies the phrase matcher only when it is active.", -"type": "boolean" +"averageClientSentimentScore": { +"description": "The average client's sentiment score.", +"format": "float", +"type": "number" }, -"displayName": { -"description": "The human-readable name of the phrase matcher.", -"type": "string" +"averageCustomerSatisfactionRating": { +"description": "The average customer satisfaction rating.", +"format": "double", +"type": "number" }, -"name": { -"description": "The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", +"averageDuration": { +"description": "The average duration.", +"format": "google-duration", "type": "string" }, -"phraseMatchRuleGroups": { -"description": "A list of phase match rule groups that are included in this matcher.", +"averageQaNormalizedScore": { +"description": "Average QA normalized score. Will exclude 0's in average calculation.", +"format": "double", +"type": "number" +}, +"averageQaQuestionNormalizedScore": { +"description": "Average QA normalized score averaged for questions averaged across all revisions of the parent scorecard. Will be only populated if the request specifies a dimension of QA_QUESTION_ID.", +"format": "double", +"type": "number" +}, +"averageSilencePercentage": { +"description": "The average silence percentage.", +"format": "float", +"type": "number" +}, +"averageTurnCount": { +"description": "The average turn count.", +"format": "float", +"type": "number" +}, +"conversationCount": { +"description": "The conversation count.", +"format": "int32", +"type": "integer" +}, +"qaTagScores": { +"description": "Average QA normalized score for all the tags.", "items": { -"$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup" +"$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "type": "array" +} }, -"revisionCreateTime": { -"description": "Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"type": "object" }, -"revisionId": { -"description": "Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567", -"readOnly": true, -"type": "string" +"GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { +"description": "Average QA normalized score for the tag.", +"id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore", +"properties": { +"averageTagNormalizedScore": { +"description": "Average tag normalized score per tag.", +"format": "double", +"type": "number" }, -"roleMatch": { -"description": "The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.", -"enum": [ -"ROLE_UNSPECIFIED", -"HUMAN_AGENT", -"AUTOMATED_AGENT", -"END_USER", -"ANY_AGENT" -], -"enumDescriptions": [ -"Participant's role is not set.", -"Participant is a human agent.", -"Participant is an automated agent.", -"Participant is an end user who conversed with the contact center.", -"Participant is either a human or automated agent." -], +"tag": { +"description": "Tag name.", "type": "string" +} }, -"type": { -"description": "Required. The type of this phrase matcher.", -"enum": [ -"PHRASE_MATCHER_TYPE_UNSPECIFIED", -"ALL_OF", -"ANY_OF" -], -"enumDescriptions": [ -"Unspecified.", -"Must meet all phrase match rule groups or there is no match.", -"If any of the phrase match rule groups are met, there is a match." -], -"type": "string" +"type": "object" }, -"updateTime": { -"description": "Output only. The most recent time at which the phrase matcher was updated.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries": { +"description": "A time series of metric values.", +"id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries", +"properties": { +"dataPoints": { +"description": "The data points that make up the time series .", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint" }, -"versionTag": { -"description": "The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.", -"type": "string" +"type": "array" } }, "type": "object" @@ -4111,6 +7132,21 @@ }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionRequest": { +"description": "Request for TuneQaScorecardRevision endpoint.", +"id": "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionRequest", +"properties": { +"filter": { +"description": "Required. Filter for selecting the feedback labels that needs to be used for training. This filter can be used to limit the feedback labels used for tuning to a feedback labels created or updated for a specific time-window etc.", +"type": "string" +}, +"validateOnly": { +"description": "Optional. Run in validate only mode, no fine tuning will actually run. Data quality validations like training data distributions will run. Even when set to false, the data quality validations will still run but once the validations complete we will proceed with the fine tune, if applicable.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata": { "description": "Metadata for undeploying an issue model.", "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata", @@ -4151,6 +7187,12 @@ "properties": {}, "type": "object" }, +"GoogleCloudContactcenterinsightsV1UndeployQaScorecardRevisionRequest": { +"description": "The request to undeploy a QaScorecardRevision", +"id": "GoogleCloudContactcenterinsightsV1UndeployQaScorecardRevisionRequest", +"properties": {}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1UploadConversationMetadata": { "description": "The metadata for an `UploadConversation` operation.", "id": "GoogleCloudContactcenterinsightsV1UploadConversationMetadata", @@ -4327,6 +7369,13 @@ "description": "All the matched phrase matchers in the call.", "type": "object" }, +"qaScorecardResults": { +"description": "Results of scoring QaScorecards.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult" +}, +"type": "array" +}, "sentiments": { "description": "Overall conversation-level sentiment for each channel of the call.", "items": { @@ -4376,6 +7425,10 @@ }, "type": "array" }, +"qaConfig": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig", +"description": "Configuration for the QA annotator." +}, "runEntityAnnotator": { "description": "Whether to run the entity annotator.", "type": "boolean" @@ -4396,6 +7449,10 @@ "description": "Whether to run the active phrase matcher annotator(s).", "type": "boolean" }, +"runQaAnnotator": { +"description": "Whether to run the QA annotator.", +"type": "boolean" +}, "runSentimentAnnotator": { "description": "Whether to run the sentiment annotator.", "type": "boolean" @@ -4415,6 +7472,31 @@ }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig": { +"description": "Configuration for the QA feature.", +"id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig", +"properties": { +"scorecardList": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList", +"description": "A manual list of scorecards to score." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList": { +"description": "Container for a list of scorecards.", +"id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList", +"properties": { +"qaScorecardRevisions": { +"description": "List of QaScorecardRevisions.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig": { "description": "Configuration for summarization.", "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig", @@ -5311,6 +8393,135 @@ }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1alpha1Dimension": { +"description": "A dimension determines the grouping key for the query. In SQL terms, these would be part of both the \"SELECT\" and \"GROUP BY\" clauses.", +"id": "GoogleCloudContactcenterinsightsV1alpha1Dimension", +"properties": { +"agentDimensionMetadata": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata", +"description": "Output only. Metadata about the agent dimension.", +"readOnly": true +}, +"dimensionKey": { +"description": "The key of the dimension.", +"enum": [ +"DIMENSION_KEY_UNSPECIFIED", +"ISSUE", +"AGENT", +"AGENT_TEAM", +"QA_QUESTION_ID", +"QA_QUESTION_ANSWER_VALUE", +"CONVERSATION_PROFILE_ID" +], +"enumDescriptions": [ +"The key of the dimension is unspecified.", +"The dimension is keyed by issues.", +"The dimension is keyed by agents.", +"The dimension is keyed by agent teams.", +"The dimension is keyed by QaQuestionIds. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing stats for the same question across different scorecard revisions.", +"The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", +"The dimension is keyed by the conversation profile ID." +], +"type": "string" +}, +"issueDimensionMetadata": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata", +"description": "Output only. Metadata about the issue dimension.", +"readOnly": true +}, +"qaQuestionAnswerDimensionMetadata": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata", +"description": "Output only. Metadata about the QA question-answer dimension.", +"readOnly": true +}, +"qaQuestionDimensionMetadata": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata", +"description": "Output only. Metadata about the QA question dimension.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata": { +"description": "Metadata about the agent dimension.", +"id": "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata", +"properties": { +"agentDisplayName": { +"description": "Optional. The agent's name", +"type": "string" +}, +"agentId": { +"description": "Optional. A user-specified string representing the agent.", +"type": "string" +}, +"agentTeam": { +"description": "Optional. A user-specified string representing the agent's team.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata": { +"description": "Metadata about the issue dimension.", +"id": "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata", +"properties": { +"issueDisplayName": { +"description": "The issue display name.", +"type": "string" +}, +"issueId": { +"description": "The issue ID.", +"type": "string" +}, +"issueModelId": { +"description": "The parent issue model ID.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata": { +"description": "Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard.", +"id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata", +"properties": { +"answerValue": { +"description": "Optional. The full body of the question.", +"type": "string" +}, +"qaQuestionId": { +"description": "Optional. The QA question ID.", +"type": "string" +}, +"qaScorecardId": { +"description": "Optional. The QA scorecard ID.", +"type": "string" +}, +"questionBody": { +"description": "Optional. The full body of the question.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata": { +"description": "Metadata about the QA question dimension.", +"id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata", +"properties": { +"qaQuestionId": { +"description": "Optional. The QA question ID.", +"type": "string" +}, +"qaScorecardId": { +"description": "Optional. The QA scorecard ID.", +"type": "string" +}, +"questionBody": { +"description": "Optional. The full body of the question.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec": { "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`).", "id": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec", @@ -5596,6 +8807,41 @@ }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel": { +"description": "Represents a conversation, resource, and label provided by the user.", +"id": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel", +"properties": { +"createTime": { +"description": "Output only. Create time of the label.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"label": { +"description": "String label.", +"type": "string" +}, +"labeledResource": { +"description": "Resource name of the resource to be labeled.", +"type": "string" +}, +"name": { +"description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", +"type": "string" +}, +"qaAnswerLabel": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue", +"description": "QaAnswer label." +}, +"updateTime": { +"description": "Output only. Update time of the label.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1alpha1GcsSource": { "description": "A Cloud Storage source of conversation data.", "id": "GoogleCloudContactcenterinsightsV1alpha1GcsSource", @@ -6040,129 +9286,572 @@ "readOnly": true, "type": "string" }, -"trainingStats": { -"$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats", -"description": "Output only. Immutable. The issue model's label statistics on its training data.", -"readOnly": true +"trainingStats": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats", +"description": "Output only. Immutable. The issue model's label statistics on its training data.", +"readOnly": true +}, +"updateTime": { +"description": "Output only. The most recent time at which the issue model was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig": { +"description": "Configs for the input data used to create the issue model.", +"id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig", +"properties": { +"filter": { +"description": "A filter to reduce the conversations used for training the model to a specific subset.", +"type": "string" +}, +"medium": { +"deprecated": true, +"description": "Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`.", +"enum": [ +"MEDIUM_UNSPECIFIED", +"PHONE_CALL", +"CHAT" +], +"enumDescriptions": [ +"Default value, if unspecified will default to PHONE_CALL.", +"The format for conversations that took place over the phone.", +"The format for conversations that took place over chat." +], +"type": "string" +}, +"trainingConversationsCount": { +"description": "Output only. Number of conversations used in training. Output only.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats": { +"description": "Aggregated statistics about an issue model.", +"id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats", +"properties": { +"analyzedConversationsCount": { +"description": "Number of conversations the issue model has analyzed at this point in time.", +"format": "int64", +"type": "string" +}, +"issueStats": { +"additionalProperties": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats" +}, +"description": "Statistics on each issue. Key is the issue's resource name.", +"type": "object" +}, +"unclassifiedConversationsCount": { +"description": "Number of analyzed conversations for which no issue was applicable at this point in time.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats": { +"description": "Aggregated statistics about an issue.", +"id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats", +"properties": { +"displayName": { +"description": "Display name of the issue.", +"type": "string" +}, +"issue": { +"description": "Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", +"type": "string" +}, +"labeledConversationsCount": { +"description": "Number of conversations attached to the issue at this point in time.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1IssueModelResult": { +"description": "Issue Modeling result on a conversation.", +"id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult", +"properties": { +"issueModel": { +"description": "Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", +"type": "string" +}, +"issues": { +"description": "All the matched issues.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse": { +"description": "The response for listing all feedback labels.", +"id": "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse", +"properties": { +"feedbackLabels": { +"description": "The feedback labels that match the request.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse": { +"description": "The response for listing feedback labels.", +"id": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse", +"properties": { +"feedbackLabels": { +"description": "The feedback labels that match the request.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The next page token.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData": { +"description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", +"id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData", +"properties": { +"displayName": { +"description": "The human-readable name of the phrase matcher.", +"type": "string" +}, +"phraseMatcher": { +"description": "The unique identifier (the resource name) of the phrase matcher.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1QaAnswer": { +"description": "An answer to a QaQuestion.", +"id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswer", +"properties": { +"answerSources": { +"description": "List of all individual answers given to the question.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource" +}, +"type": "array" +}, +"answerValue": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue", +"description": "The main answer value, incorporating any manual edits if they exist." +}, +"conversation": { +"description": "The conversation the answer applies to.", +"type": "string" +}, +"potentialScore": { +"deprecated": true, +"description": "The maximum potential score of the question. If the question was answered using `na_value`, this field will be zero. Deprecated: Use AnswerValue.potential_score instead.", +"format": "double", +"type": "number" +}, +"qaQuestion": { +"description": "The QaQuestion answered by this answer.", +"type": "string" +}, +"questionBody": { +"description": "Question text. E.g., \"Did the agent greet the customer?\"", +"type": "string" +}, +"tags": { +"description": "User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource": { +"description": "A question may have multiple answers from varying sources, one of which becomes the \"main\" answer above. AnswerSource represents each individual answer.", +"id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource", +"properties": { +"answerValue": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue", +"description": "The answer value from this source." +}, +"sourceType": { +"description": "What created the answer.", +"enum": [ +"SOURCE_TYPE_UNSPECIFIED", +"SYSTEM_GENERATED", +"MANUAL_EDIT" +], +"enumDescriptions": [ +"Source type is unspecified.", +"Answer was system-generated; created during an Insights analysis.", +"Answer was created by a human via manual edit." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue": { +"description": "Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question.", +"id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue", +"properties": { +"boolValue": { +"description": "Boolean value.", +"type": "boolean" +}, +"key": { +"description": "A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.", +"type": "string" +}, +"naValue": { +"description": "A value of \"Not Applicable (N/A)\".", +"type": "boolean" +}, +"normalizedScore": { +"description": "Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0", +"format": "double", +"readOnly": true, +"type": "number" +}, +"numValue": { +"description": "Numerical value.", +"format": "double", +"type": "number" +}, +"potentialScore": { +"description": "Output only. The maximum potential score of the question.", +"format": "double", +"readOnly": true, +"type": "number" +}, +"score": { +"description": "Output only. Numerical score of the answer.", +"format": "double", +"readOnly": true, +"type": "number" +}, +"strValue": { +"description": "String value.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult": { +"description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.", +"id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult", +"properties": { +"agentId": { +"description": "ID of the agent that handled the conversation.", +"type": "string" +}, +"conversation": { +"description": "The conversation scored by this result.", +"type": "string" +}, +"createTime": { +"description": "Output only. The timestamp that the revision was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}", +"type": "string" +}, +"normalizedScore": { +"description": "The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.", +"format": "double", +"type": "number" +}, +"potentialScore": { +"description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", +"format": "double", +"type": "number" +}, +"qaAnswers": { +"description": "Set of QaAnswers represented in the result.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswer" +}, +"type": "array" +}, +"qaScorecardRevision": { +"description": "The QaScorecardRevision scored by this result.", +"type": "string" +}, +"qaTagResults": { +"description": "Collection of tags and their scores.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" +}, +"type": "array" +}, +"score": { +"description": "The overall numerical score of the result, incorporating any manual edits if they exist.", +"format": "double", +"type": "number" +}, +"scoreSources": { +"description": "List of all individual score sets.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult": { +"description": "Tags and their corresponding results.", +"id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult", +"properties": { +"normalizedScore": { +"description": "The normalized score the tag applies to.", +"format": "double", +"type": "number" +}, +"potentialScore": { +"description": "The potential score the tag applies to.", +"format": "double", +"type": "number" }, -"updateTime": { -"description": "Output only. The most recent time at which the issue model was updated.", -"format": "google-datetime", -"readOnly": true, +"score": { +"description": "The score the tag applies to.", +"format": "double", +"type": "number" +}, +"tag": { +"description": "The tag the score applies to.", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig": { -"description": "Configs for the input data used to create the issue model.", -"id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig", +"GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource": { +"description": "A scorecard result may have multiple sets of scores from varying sources, one of which becomes the \"main\" answer above. A ScoreSource represents each individual set of scores.", +"id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource", "properties": { -"filter": { -"description": "A filter to reduce the conversations used for training the model to a specific subset.", -"type": "string" +"normalizedScore": { +"description": "The normalized score, which is the score divided by the potential score.", +"format": "double", +"type": "number" }, -"medium": { -"deprecated": true, -"description": "Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`.", +"potentialScore": { +"description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", +"format": "double", +"type": "number" +}, +"qaTagResults": { +"description": "Collection of tags and their scores.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" +}, +"type": "array" +}, +"score": { +"description": "The overall numerical score of the result.", +"format": "double", +"type": "number" +}, +"sourceType": { +"description": "What created the score.", "enum": [ -"MEDIUM_UNSPECIFIED", -"PHONE_CALL", -"CHAT" +"SOURCE_TYPE_UNSPECIFIED", +"SYSTEM_GENERATED_ONLY", +"INCLUDES_MANUAL_EDITS" ], "enumDescriptions": [ -"Default value, if unspecified will default to PHONE_CALL.", -"The format for conversations that took place over the phone.", -"The format for conversations that took place over chat." +"Source type is unspecified.", +"Score is derived only from system-generated answers.", +"Score is derived from both system-generated answers, and includes any manual edits if they exist." ], "type": "string" -}, -"trainingConversationsCount": { -"description": "Output only. Number of conversations used in training. Output only.", -"format": "int64", -"readOnly": true, -"type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats": { -"description": "Aggregated statistics about an issue model.", -"id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats", +"GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata": { +"description": "The metadata from querying metrics.", +"id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse": { +"description": "The response for querying metrics.", +"id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse", "properties": { -"analyzedConversationsCount": { -"description": "Number of conversations the issue model has analyzed at this point in time.", -"format": "int64", +"location": { +"description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "type": "string" }, -"issueStats": { -"additionalProperties": { -"$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats" +"macroAverageSlice": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice", +"description": "The macro average slice contains aggregated averages across the selected dimension. i.e. if group_by agent is specified this field will contain the average across all agents. This field is only populated if the request specifies a Dimension." }, -"description": "Statistics on each issue. Key is the issue's resource name.", -"type": "object" +"slices": { +"description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice" }, -"unclassifiedConversationsCount": { -"description": "Number of analyzed conversations for which no issue was applicable at this point in time.", -"format": "int64", +"type": "array" +}, +"updateTime": { +"description": "The metrics last update time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats": { -"description": "Aggregated statistics about an issue.", -"id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats", +"GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice": { +"description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request. For example, if the request specifies a single ISSUE dimension and it has a cardinality of 2 (i.e. the data used to compute the metrics has 2 issues in total), the response will have 2 slices: * Slice 1 -> dimensions=[Issue 1] * Slice 2 -> dimensions=[Issue 2]", +"id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice", "properties": { -"displayName": { -"description": "Display name of the issue.", -"type": "string" +"dimensions": { +"description": "A unique combination of dimensions that this slice represents.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1Dimension" }, -"issue": { -"description": "Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", -"type": "string" +"type": "array" }, -"labeledConversationsCount": { -"description": "Number of conversations attached to the issue at this point in time.", -"format": "int64", -"type": "string" +"timeSeries": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries", +"description": "A time series of metric values. This is only populated if the request specifies a time granularity other than NONE." +}, +"total": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint", +"description": "The total metric value. The interval of this data point is [starting create time, ending create time) from the request." } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1alpha1IssueModelResult": { -"description": "Issue Modeling result on a conversation.", -"id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult", +"GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint": { +"description": "A data point contains the metric values mapped to an interval.", +"id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint", "properties": { -"issueModel": { -"description": "Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", +"conversationMeasure": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure", +"description": "The measure related to conversations." +}, +"interval": { +"$ref": "GoogleTypeInterval", +"description": "The interval that this data point represents. * If this is the total data point, the interval is [starting create time, ending create time) from the request. * If this a data point from the time series, the interval is [time, time + time granularity from the request)." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure": { +"description": "The measure related to conversations.", +"id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure", +"properties": { +"averageAgentSentimentScore": { +"description": "The average agent's sentiment score.", +"format": "float", +"type": "number" +}, +"averageClientSentimentScore": { +"description": "The average client's sentiment score.", +"format": "float", +"type": "number" +}, +"averageCustomerSatisfactionRating": { +"description": "The average customer satisfaction rating.", +"format": "double", +"type": "number" +}, +"averageDuration": { +"description": "The average duration.", +"format": "google-duration", "type": "string" }, -"issues": { -"description": "All the matched issues.", +"averageQaNormalizedScore": { +"description": "Average QA normalized score. Will exclude 0's in average calculation.", +"format": "double", +"type": "number" +}, +"averageQaQuestionNormalizedScore": { +"description": "Average QA normalized score averaged for questions averaged across all revisions of the parent scorecard. Will be only populated if the request specifies a dimension of QA_QUESTION_ID.", +"format": "double", +"type": "number" +}, +"averageSilencePercentage": { +"description": "The average silence percentage.", +"format": "float", +"type": "number" +}, +"averageTurnCount": { +"description": "The average turn count.", +"format": "float", +"type": "number" +}, +"conversationCount": { +"description": "The conversation count.", +"format": "int32", +"type": "integer" +}, +"qaTagScores": { +"description": "Average QA normalized score for all the tags.", "items": { -"$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "type": "array" } }, "type": "object" }, -"GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData": { -"description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", -"id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData", +"GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { +"description": "Average QA normalized score for the tag.", +"id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore", "properties": { -"displayName": { -"description": "The human-readable name of the phrase matcher.", -"type": "string" +"averageTagNormalizedScore": { +"description": "Average tag normalized score per tag.", +"format": "double", +"type": "number" }, -"phraseMatcher": { -"description": "The unique identifier (the resource name) of the phrase matcher.", +"tag": { +"description": "Tag name.", "type": "string" } }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries": { +"description": "A time series of metric values.", +"id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries", +"properties": { +"dataPoints": { +"description": "The data points that make up the time series .", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig": { "description": "DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist.", "id": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig", @@ -6452,6 +10141,151 @@ }, "type": "object" }, +"GoogleIamV1AuditConfig": { +"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", +"id": "GoogleIamV1AuditConfig", +"properties": { +"auditLogConfigs": { +"description": "The configuration for logging of each type of permission.", +"items": { +"$ref": "GoogleIamV1AuditLogConfig" +}, +"type": "array" +}, +"service": { +"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleIamV1AuditLogConfig": { +"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", +"id": "GoogleIamV1AuditLogConfig", +"properties": { +"exemptedMembers": { +"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", +"items": { +"type": "string" +}, +"type": "array" +}, +"logType": { +"description": "The log type that this config enables.", +"enum": [ +"LOG_TYPE_UNSPECIFIED", +"ADMIN_READ", +"DATA_WRITE", +"DATA_READ" +], +"enumDescriptions": [ +"Default case. Should never be this.", +"Admin reads. Example: CloudIAM getIamPolicy", +"Data writes. Example: CloudSQL Users create", +"Data reads. Example: CloudSQL Users list" +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleIamV1Binding": { +"description": "Associates `members`, or principals, with a `role`.", +"id": "GoogleIamV1Binding", +"properties": { +"condition": { +"$ref": "GoogleTypeExpr", +"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." +}, +"members": { +"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"role": { +"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", +"type": "string" +} +}, +"type": "object" +}, +"GoogleIamV1Policy": { +"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", +"id": "GoogleIamV1Policy", +"properties": { +"auditConfigs": { +"description": "Specifies cloud audit logging configuration for this policy.", +"items": { +"$ref": "GoogleIamV1AuditConfig" +}, +"type": "array" +}, +"bindings": { +"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", +"items": { +"$ref": "GoogleIamV1Binding" +}, +"type": "array" +}, +"etag": { +"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", +"format": "byte", +"type": "string" +}, +"version": { +"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleIamV1SetIamPolicyRequest": { +"description": "Request message for `SetIamPolicy` method.", +"id": "GoogleIamV1SetIamPolicyRequest", +"properties": { +"policy": { +"$ref": "GoogleIamV1Policy", +"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." +}, +"updateMask": { +"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", +"format": "google-fieldmask", +"type": "string" +} +}, +"type": "object" +}, +"GoogleIamV1TestIamPermissionsRequest": { +"description": "Request message for `TestIamPermissions` method.", +"id": "GoogleIamV1TestIamPermissionsRequest", +"properties": { +"permissions": { +"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleIamV1TestIamPermissionsResponse": { +"description": "Response message for `TestIamPermissions` method.", +"id": "GoogleIamV1TestIamPermissionsResponse", +"properties": { +"permissions": { +"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleLongrunningListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "GoogleLongrunningListOperationsResponse", @@ -6537,6 +10371,46 @@ } }, "type": "object" +}, +"GoogleTypeExpr": { +"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", +"id": "GoogleTypeExpr", +"properties": { +"description": { +"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", +"type": "string" +}, +"expression": { +"description": "Textual representation of an expression in Common Expression Language syntax.", +"type": "string" +}, +"location": { +"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", +"type": "string" +}, +"title": { +"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleTypeInterval": { +"description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.", +"id": "GoogleTypeInterval", +"properties": { +"endTime": { +"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", +"format": "google-datetime", +"type": "string" +}, +"startTime": { +"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index 09485dd011..6a4506347f 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -2540,7 +2540,7 @@ } } }, -"revision": "20240923", +"revision": "20241008", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2680,6 +2680,10 @@ "$ref": "NetworkPolicyConfig", "description": "Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes." }, +"parallelstoreCsiDriverConfig": { +"$ref": "ParallelstoreCsiDriverConfig", +"description": "Configuration for the Cloud Storage Parallelstore CSI driver." +}, "rayOperatorConfig": { "$ref": "RayOperatorConfig", "description": "Optional. Configuration for Ray Operator addon." @@ -6337,6 +6341,17 @@ false }, "type": "object" }, +"ParallelstoreCsiDriverConfig": { +"description": "Configuration for the Cloud Storage Parallelstore CSI driver.", +"id": "ParallelstoreCsiDriverConfig", +"properties": { +"enabled": { +"description": "Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster.", +"type": "boolean" +} +}, +"type": "object" +}, "ParentProductConfig": { "description": "ParentProductConfig is the configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of a GKE cluster and take the ownership of the cluster.", "id": "ParentProductConfig", @@ -6640,6 +6655,10 @@ false "description": "The default version for newly created clusters on the channel.", "type": "string" }, +"upgradeTargetVersion": { +"description": "The auto upgrade target version for clusters on the channel.", +"type": "string" +}, "validVersions": { "description": "List of valid versions for the channel.", "items": { diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index 0ad4412524..2ff7a09bea 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -348,6 +348,36 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"fetchClusterUpgradeInfo": { +"description": "Fetch upgrade information of a specific cluster.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:fetchClusterUpgradeInfo", +"httpMethod": "GET", +"id": "container.projects.locations.clusters.fetchClusterUpgradeInfo", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name (project, location, cluster) of the cluster to get. Specified in the format `projects/*/locations/*/clusters/*` or `projects/*/zones/*/clusters/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", +"required": true, +"type": "string" +}, +"version": { +"description": "API request version that initiates this operation.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:fetchClusterUpgradeInfo", +"response": { +"$ref": "ClusterUpgradeInfo" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets the details for a specific cluster.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", @@ -896,6 +926,36 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"fetchNodePoolUpgradeInfo": { +"description": "Fetch upgrade information of a specific nodepool.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:fetchNodePoolUpgradeInfo", +"httpMethod": "GET", +"id": "container.projects.locations.clusters.nodePools.fetchNodePoolUpgradeInfo", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name (project, location, cluster, nodepool) of the nodepool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", +"required": true, +"type": "string" +}, +"version": { +"description": "API request version that initiates this operation.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:fetchNodePoolUpgradeInfo", +"response": { +"$ref": "NodePoolUpgradeInfo" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Retrieves the requested node pool.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}", @@ -1473,6 +1533,36 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"fetchClusterUpgradeInfo": { +"description": "Fetch upgrade information of a specific cluster.", +"flatPath": "v1beta1/projects/{projectsId}/zones/{zonesId}/clusters/{clustersId}:fetchClusterUpgradeInfo", +"httpMethod": "GET", +"id": "container.projects.zones.clusters.fetchClusterUpgradeInfo", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name (project, location, cluster) of the cluster to get. Specified in the format `projects/*/locations/*/clusters/*` or `projects/*/zones/*/clusters/*`.", +"location": "path", +"pattern": "^projects/[^/]+/zones/[^/]+/clusters/[^/]+$", +"required": true, +"type": "string" +}, +"version": { +"description": "API request version that initiates this operation.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:fetchClusterUpgradeInfo", +"response": { +"$ref": "ClusterUpgradeInfo" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets the details for a specific cluster.", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", @@ -2147,6 +2237,36 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"fetchNodePoolUpgradeInfo": { +"description": "Fetch upgrade information of a specific nodepool.", +"flatPath": "v1beta1/projects/{projectsId}/zones/{zonesId}/clusters/{clustersId}/nodePools/{nodePoolsId}:fetchNodePoolUpgradeInfo", +"httpMethod": "GET", +"id": "container.projects.zones.clusters.nodePools.fetchNodePoolUpgradeInfo", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name (project, location, cluster, nodepool) of the nodepool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`.", +"location": "path", +"pattern": "^projects/[^/]+/zones/[^/]+/clusters/[^/]+/nodePools/[^/]+$", +"required": true, +"type": "string" +}, +"version": { +"description": "API request version that initiates this operation.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:fetchNodePoolUpgradeInfo", +"response": { +"$ref": "NodePoolUpgradeInfo" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Retrieves the requested node pool.", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", @@ -2565,7 +2685,7 @@ } } }, -"revision": "20240923", +"revision": "20241008", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2721,6 +2841,10 @@ "$ref": "NetworkPolicyConfig", "description": "Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes." }, +"parallelstoreCsiDriverConfig": { +"$ref": "ParallelstoreCsiDriverConfig", +"description": "Configuration for the Cloud Storage Parallelstore CSI driver." +}, "rayOperatorConfig": { "$ref": "RayOperatorConfig", "description": "Optional. Configuration for Ray Operator addon." @@ -2794,6 +2918,27 @@ }, "type": "object" }, +"AutoMonitoringConfig": { +"description": "AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring.", +"id": "AutoMonitoringConfig", +"properties": { +"scope": { +"description": "Scope for GKE Workload Auto-Monitoring.", +"enum": [ +"SCOPE_UNSPECIFIED", +"ALL", +"NONE" +], +"enumDescriptions": [ +"Not set.", +"Auto-Monitoring is enabled for all supported applications.", +"Disable Auto-Monitoring." +], +"type": "string" +} +}, +"type": "object" +}, "AutoUpgradeOptions": { "description": "AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.", "id": "AutoUpgradeOptions", @@ -4066,6 +4211,80 @@ }, "type": "object" }, +"ClusterUpgradeInfo": { +"description": "ClusterUpgradeInfo contains the upgrade information of a cluster.", +"id": "ClusterUpgradeInfo", +"properties": { +"autoUpgradeStatus": { +"description": "The auto upgrade status.", +"items": { +"enum": [ +"UNKNOWN", +"ACTIVE", +"MINOR_UPGRADE_PAUSED", +"UPGRADE_PAUSED" +], +"enumDescriptions": [ +"UNKNOWN indicates an unknown status.", +"ACTIVE indicates an active status.", +"MINOR_UPGRADE_PAUSED indicates the minor version upgrade is paused.", +"UPGRADE_PAUSED indicates the upgrade is paused." +], +"type": "string" +}, +"type": "array" +}, +"endOfExtendedSupportTimestamp": { +"description": "The cluster's current minor version's end of extended support timestamp.", +"type": "string" +}, +"endOfStandardSupportTimestamp": { +"description": "The cluster's current minor version's end of standard support timestamp.", +"type": "string" +}, +"minorTargetVersion": { +"description": "minor_target_version indicates the target version for minor upgrade.", +"type": "string" +}, +"patchTargetVersion": { +"description": "patch_target_version indicates the target version for patch upgrade.", +"type": "string" +}, +"pausedReason": { +"description": "The auto upgrade paused reason.", +"items": { +"enum": [ +"AUTO_UPGRADE_PAUSED_REASON_UNSPECIFIED", +"MAINTENANCE_WINDOW", +"MAINTENANCE_EXCLUSION_NO_UPGRADES", +"MAINTENANCE_EXCLUSION_NO_MINOR_UPGRADES", +"CLUSTER_DISRUPTION_BUDGET", +"CLUSTER_DISRUPTION_BUDGET_MINOR_UPGRADE", +"SYSTEM_CONFIG" +], +"enumDescriptions": [ +"AUTO_UPGRADE_PAUSED_REASON_UNSPECIFIED indicates an unspecified reason.", +"MAINTENANCE_WINDOW indicates the cluster is outside customer maintenance window.", +"MAINTENANCE_EXCLUSION_NO_UPGRADES indicates the cluster is in a maintenance exclusion with scope NO_UPGRADES.", +"MAINTENANCE_EXCLUSION_NO_MINOR_UPGRADES indicates the cluster is in a maintenance exclusion with scope NO_MINOR_UPGRADES.", +"CLUSTER_DISRUPTION_BUDGET indicates the cluster is outside the cluster disruption budget.", +"CLUSTER_DISRUPTION_BUDGET_MINOR_UPGRADE indicates the cluster is outside the cluster disruption budget for minor version upgrade.", +"SYSTEM_CONFIG indicates the cluster upgrade is paused by system config." +], +"type": "string" +}, +"type": "array" +}, +"upgradeDetails": { +"description": "The list of past auto upgrades.", +"items": { +"$ref": "UpgradeDetails" +}, +"type": "array" +} +}, +"type": "object" +}, "CompleteIPRotationRequest": { "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode.", "id": "CompleteIPRotationRequest", @@ -5455,6 +5674,10 @@ false "description": "ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus.", "id": "ManagedPrometheusConfig", "properties": { +"autoMonitoringConfig": { +"$ref": "AutoMonitoringConfig", +"description": "GKE Workload Auto-Monitoring Configuration." +}, "enabled": { "description": "Enable Managed Collection.", "type": "boolean" @@ -6453,6 +6676,76 @@ false }, "type": "object" }, +"NodePoolUpgradeInfo": { +"description": "NodePoolUpgradeInfo contains the upgrade information of a nodepool.", +"id": "NodePoolUpgradeInfo", +"properties": { +"autoUpgradeStatus": { +"description": "The auto upgrade status.", +"items": { +"enum": [ +"UNKNOWN", +"ACTIVE", +"MINOR_UPGRADE_PAUSED", +"UPGRADE_PAUSED" +], +"enumDescriptions": [ +"UNKNOWN indicates an unknown status.", +"ACTIVE indicates an active status.", +"MINOR_UPGRADE_PAUSED indicates the minor version upgrade is paused.", +"UPGRADE_PAUSED indicates the upgrade is paused." +], +"type": "string" +}, +"type": "array" +}, +"endOfExtendedSupportTimestamp": { +"description": "The nodepool's current minor version's end of extended support timestamp.", +"type": "string" +}, +"endOfStandardSupportTimestamp": { +"description": "The nodepool's current minor version's end of standard support timestamp.", +"type": "string" +}, +"minorTargetVersion": { +"description": "minor_target_version indicates the target version for minor upgrade.", +"type": "string" +}, +"patchTargetVersion": { +"description": "patch_target_version indicates the target version for patch upgrade.", +"type": "string" +}, +"pausedReason": { +"description": "The auto upgrade paused reason.", +"items": { +"enum": [ +"AUTO_UPGRADE_PAUSED_REASON_UNSPECIFIED", +"MAINTENANCE_WINDOW", +"MAINTENANCE_EXCLUSION_NO_UPGRADES", +"MAINTENANCE_EXCLUSION_NO_MINOR_UPGRADES", +"SYSTEM_CONFIG" +], +"enumDescriptions": [ +"AUTO_UPGRADE_PAUSED_REASON_UNSPECIFIED indicates an unspecified reason.", +"MAINTENANCE_WINDOW indicates the cluster is outside customer maintenance window.", +"MAINTENANCE_EXCLUSION_NO_UPGRADES indicates the cluster is in a maintenance exclusion with scope NO_UPGRADES.", +"MAINTENANCE_EXCLUSION_NO_MINOR_UPGRADES indicates the cluster is in a maintenance exclusion with scope NO_MINOR_UPGRADES.", +"SYSTEM_CONFIG indicates the cluster upgrade is paused by system config." +], +"type": "string" +}, +"type": "array" +}, +"upgradeDetails": { +"description": "The list of past auto upgrades.", +"items": { +"$ref": "UpgradeDetails" +}, +"type": "array" +} +}, +"type": "object" +}, "NodeTaint": { "description": "Kubernetes taint is composed of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.", "id": "NodeTaint", @@ -6760,6 +7053,17 @@ false }, "type": "object" }, +"ParallelstoreCsiDriverConfig": { +"description": "Configuration for the Cloud Storage Parallelstore CSI driver.", +"id": "ParallelstoreCsiDriverConfig", +"properties": { +"enabled": { +"description": "Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster.", +"type": "boolean" +} +}, +"type": "object" +}, "ParentProductConfig": { "description": "ParentProductConfig is the configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of a GKE cluster and take the ownership of the cluster.", "id": "ParentProductConfig", @@ -7118,6 +7422,10 @@ false "description": "The default version for newly created clusters on the channel.", "type": "string" }, +"upgradeTargetVersion": { +"description": "The auto upgrade target version for clusters on the channel.", +"type": "string" +}, "validVersions": { "description": "List of valid versions for the channel.", "items": { @@ -8387,6 +8695,48 @@ false }, "type": "object" }, +"UpgradeDetails": { +"description": "UpgradeDetails contains detailed information of each individual upgrade operation.", +"id": "UpgradeDetails", +"properties": { +"endTime": { +"description": "The end timestamp of the upgrade.", +"format": "google-datetime", +"type": "string" +}, +"initialVersion": { +"description": "The version before the upgrade.", +"type": "string" +}, +"startTime": { +"description": "The start timestamp of the upgrade.", +"format": "google-datetime", +"type": "string" +}, +"state": { +"description": "Output only. The state of the upgrade.", +"enum": [ +"UNKNOWN", +"FAILED", +"SUCCEEDED", +"CANCELED" +], +"enumDescriptions": [ +"Upgrade state is unknown.", +"Upgrade has failed with an error.", +"Upgrade has succeeded.", +"Upgrade has been canceled." +], +"readOnly": true, +"type": "string" +}, +"targetVersion": { +"description": "The version after the upgrade.", +"type": "string" +} +}, +"type": "object" +}, "UpgradeEvent": { "description": "UpgradeEvent is a notification sent to customers by the cluster server when a resource is upgrading.", "id": "UpgradeEvent", diff --git a/googleapiclient/discovery_cache/documents/content.v2.1.json b/googleapiclient/discovery_cache/documents/content.v2.1.json index 61e5bc6813..540731b84a 100644 --- a/googleapiclient/discovery_cache/documents/content.v2.1.json +++ b/googleapiclient/discovery_cache/documents/content.v2.1.json @@ -1457,7 +1457,7 @@ "type": "string" }, "updateMask": { -"description": "Required. List of fields being updated.", +"description": "Optional. List of fields being updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4313,141 +4313,6 @@ } } }, -"settlementreports": { -"methods": { -"get": { -"description": "Retrieves a settlement report from your Merchant Center account.", -"flatPath": "{merchantId}/settlementreports/{settlementId}", -"httpMethod": "GET", -"id": "content.settlementreports.get", -"parameterOrder": [ -"merchantId", -"settlementId" -], -"parameters": { -"merchantId": { -"description": "The Merchant Center account of the settlement report.", -"format": "uint64", -"location": "path", -"required": true, -"type": "string" -}, -"settlementId": { -"description": "The Google-provided ID of the settlement.", -"location": "path", -"required": true, -"type": "string" -} -}, -"path": "{merchantId}/settlementreports/{settlementId}", -"response": { -"$ref": "SettlementReport" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -}, -"list": { -"description": "Retrieves a list of settlement reports from your Merchant Center account.", -"flatPath": "{merchantId}/settlementreports", -"httpMethod": "GET", -"id": "content.settlementreports.list", -"parameterOrder": [ -"merchantId" -], -"parameters": { -"maxResults": { -"description": "The maximum number of settlements to return in the response, used for paging. The default value is 200 returns per page, and the maximum allowed value is 5000 returns per page.", -"format": "uint32", -"location": "query", -"type": "integer" -}, -"merchantId": { -"description": "The Merchant Center account to list settlements for.", -"format": "uint64", -"location": "path", -"required": true, -"type": "string" -}, -"pageToken": { -"description": "The token returned by the previous request.", -"location": "query", -"type": "string" -}, -"transferEndDate": { -"description": "Obtains settlements which have transactions before this date (inclusively), in ISO 8601 format.", -"location": "query", -"type": "string" -}, -"transferStartDate": { -"description": "Obtains settlements which have transactions after this date (inclusively), in ISO 8601 format.", -"location": "query", -"type": "string" -} -}, -"path": "{merchantId}/settlementreports", -"response": { -"$ref": "SettlementreportsListResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -} -} -}, -"settlementtransactions": { -"methods": { -"list": { -"description": "Retrieves a list of transactions for the settlement.", -"flatPath": "{merchantId}/settlementreports/{settlementId}/transactions", -"httpMethod": "GET", -"id": "content.settlementtransactions.list", -"parameterOrder": [ -"merchantId", -"settlementId" -], -"parameters": { -"maxResults": { -"description": "The maximum number of transactions to return in the response, used for paging. The default value is 200 transactions per page, and the maximum allowed value is 5000 transactions per page.", -"format": "uint32", -"location": "query", -"type": "integer" -}, -"merchantId": { -"description": "The Merchant Center account to list transactions for.", -"format": "uint64", -"location": "path", -"required": true, -"type": "string" -}, -"pageToken": { -"description": "The token returned by the previous request.", -"location": "query", -"type": "string" -}, -"settlementId": { -"description": "The Google-provided ID of the settlement.", -"location": "path", -"required": true, -"type": "string" -}, -"transactionIds": { -"description": "The list of transactions to return. If not set, all transactions will be returned.", -"location": "query", -"repeated": true, -"type": "string" -} -}, -"path": "{merchantId}/settlementreports/{settlementId}/transactions", -"response": { -"$ref": "SettlementtransactionsListResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -} -} -}, "shippingsettings": { "methods": { "custombatch": { @@ -4705,7 +4570,7 @@ } } }, -"revision": "20240825", +"revision": "20241023", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { @@ -7926,7 +7791,7 @@ false "No issues available to review.", "Account will be automatically reviewed at the end of the grace period.", "Account is retired. Should not appear in MC.", -"Account was already reviewd." +"Account has already been reviewed. You can't request further reviews." ], "type": "string" }, @@ -13624,193 +13489,6 @@ false }, "type": "object" }, -"SettlementReport": { -"description": " Settlement reports detail order-level and item-level credits and debits between you and Google.", -"id": "SettlementReport", -"properties": { -"endDate": { -"description": "The end date on which all transactions are included in the report, in ISO 8601 format.", -"type": "string" -}, -"kind": { -"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#settlementReport`\"", -"type": "string" -}, -"previousBalance": { -"$ref": "Price", -"description": "The residual amount from the previous invoice. This is set only if the previous invoices are not paid because of negative balance." -}, -"settlementId": { -"description": "The ID of the settlement report.", -"type": "string" -}, -"startDate": { -"description": "The start date on which all transactions are included in the report, in ISO 8601 format.", -"type": "string" -}, -"transferAmount": { -"$ref": "Price", -"description": "The money due to the merchant." -}, -"transferDate": { -"description": "Date on which transfer for this payment was initiated by Google, in ISO 8601 format.", -"type": "string" -}, -"transferIds": { -"description": "The list of bank identifiers used for the transfer. For example, Trace ID for Federal Automated Clearing House (ACH). This may also be known as the Wire ID.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"SettlementTransaction": { -"description": "Settlement transactions give a detailed breakdown of the settlement report.", -"id": "SettlementTransaction", -"properties": { -"amount": { -"$ref": "SettlementTransactionAmount", -"description": "The amount for the transaction." -}, -"identifiers": { -"$ref": "SettlementTransactionIdentifiers", -"description": "Identifiers of the transaction." -}, -"kind": { -"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#settlementTransaction`\"", -"type": "string" -}, -"transaction": { -"$ref": "SettlementTransactionTransaction", -"description": "Details of the transaction." -} -}, -"type": "object" -}, -"SettlementTransactionAmount": { -"id": "SettlementTransactionAmount", -"properties": { -"commission": { -"$ref": "SettlementTransactionAmountCommission" -}, -"description": { -"description": "The description of the event. Acceptable values are: - \"`taxWithhold`\" - \"`principal`\" - \"`principalAdjustment`\" - \"`shippingFee`\" - \"`merchantRemittedSalesTax`\" - \"`googleRemittedSalesTax`\" - \"`merchantCoupon`\" - \"`merchantCouponTax`\" - \"`merchantRemittedDisposalTax`\" - \"`googleRemittedDisposalTax`\" - \"`merchantRemittedRedemptionFee`\" - \"`googleRemittedRedemptionFee`\" - \"`eeeEcoFee`\" - \"`furnitureEcoFee`\" - \"`copyPrivateFee`\" - \"`eeeEcoFeeCommission`\" - \"`furnitureEcoFeeCommission`\" - \"`copyPrivateFeeCommission`\" - \"`principalRefund`\" - \"`principalRefundTax`\" - \"`itemCommission`\" - \"`adjustmentCommission`\" - \"`shippingFeeCommission`\" - \"`commissionRefund`\" - \"`damaged`\" - \"`damagedOrDefectiveItem`\" - \"`expiredItem`\" - \"`faultyItem`\" - \"`incorrectItemReceived`\" - \"`itemMissing`\" - \"`qualityNotExpected`\" - \"`receivedTooLate`\" - \"`storePackageMissing`\" - \"`transitPackageMissing`\" - \"`unsuccessfulDeliveryUndeliverable`\" - \"`wrongChargeInStore`\" - \"`wrongItem`\" - \"`returns`\" - \"`undeliverable`\" - \"`issueRelatedRefundAndReplacementAmountDescription`\" - \"`refundFromMerchant`\" - \"`returnLabelShippingFee`\" - \"`lumpSumCorrection`\" - \"`pspFee`\" - \"`principalRefundDoesNotFit`\" - \"`principalRefundOrderedWrongItem`\" - \"`principalRefundQualityNotExpected`\" - \"`principalRefundBetterPriceFound`\" - \"`principalRefundNoLongerNeeded`\" - \"`principalRefundChangedMind`\" - \"`principalRefundReceivedTooLate`\" - \"`principalRefundIncorrectItemReceived`\" - \"`principalRefundDamagedOrDefectiveItem`\" - \"`principalRefundDidNotMatchDescription`\" - \"`principalRefundExpiredItem`\" ", -"type": "string" -}, -"transactionAmount": { -"$ref": "Price", -"description": "The amount that contributes to the line item price." -}, -"type": { -"description": "The type of the amount. Acceptable values are: - \"`itemPrice`\" - \"`orderPrice`\" - \"`refund`\" - \"`earlyRefund`\" - \"`courtesyRefund`\" - \"`returnRefund`\" - \"`returnLabelShippingFeeAmount`\" - \"`lumpSumCorrectionAmount`\" ", -"type": "string" -} -}, -"type": "object" -}, -"SettlementTransactionAmountCommission": { -"id": "SettlementTransactionAmountCommission", -"properties": { -"category": { -"description": "The category of the commission. Acceptable values are: - \"`animalsAndPetSupplies`\" - \"`dogCatFoodAndCatLitter`\" - \"`apparelAndAccessories`\" - \"`shoesHandbagsAndSunglasses`\" - \"`costumesAndAccessories`\" - \"`jewelry`\" - \"`watches`\" - \"`hobbiesArtsAndCrafts`\" - \"`homeAndGarden`\" - \"`entertainmentCollectibles`\" - \"`collectibleCoins`\" - \"`sportsCollectibles`\" - \"`sportingGoods`\" - \"`toysAndGames`\" - \"`musicalInstruments`\" - \"`giftCards`\" - \"`babyAndToddler`\" - \"`babyFoodWipesAndDiapers`\" - \"`businessAndIndustrial`\" - \"`camerasOpticsAndPhotography`\" - \"`consumerElectronics`\" - \"`electronicsAccessories`\" - \"`personalComputers`\" - \"`videoGameConsoles`\" - \"`foodAndGrocery`\" - \"`beverages`\" - \"`tobaccoProducts`\" - \"`furniture`\" - \"`hardware`\" - \"`buildingMaterials`\" - \"`tools`\" - \"`healthAndPersonalCare`\" - \"`beauty`\" - \"`householdSupplies`\" - \"`kitchenAndDining`\" - \"`majorAppliances`\" - \"`luggageAndBags`\" - \"`media`\" - \"`officeSupplies`\" - \"`softwareAndVideoGames`\" - \"`vehiclePartsAndAccessories`\" - \"`vehicleTiresAndWheels`\" - \"`vehicles`\" - \"`everythingElse`\" ", -"type": "string" -}, -"rate": { -"description": "Rate of the commission in percentage.", -"type": "string" -} -}, -"type": "object" -}, -"SettlementTransactionIdentifiers": { -"id": "SettlementTransactionIdentifiers", -"properties": { -"adjustmentId": { -"description": "The identifier of the adjustments, if it's available.", -"type": "string" -}, -"merchantOrderId": { -"description": "The merchant provided order ID.", -"type": "string" -}, -"orderItemId": { -"description": "The identifier of the item.", -"type": "string" -}, -"settlementEntryId": { -"description": "The unique ID of the settlement transaction entry.", -"type": "string" -}, -"shipmentIds": { -"description": "The shipment ids for the item.", -"items": { -"type": "string" -}, -"type": "array" -}, -"transactionId": { -"description": "The Google transaction ID.", -"type": "string" -} -}, -"type": "object" -}, -"SettlementTransactionTransaction": { -"id": "SettlementTransactionTransaction", -"properties": { -"postDate": { -"description": "The time on which the event occurred in ISO 8601 format.", -"type": "string" -}, -"type": { -"description": "The type of the transaction that occurred. Acceptable values are: - \"`order`\" - \"`reversal`\" - \"`orderRefund`\" - \"`reversalRefund`\" - \"`issueRelatedRefundAndReplacement`\" - \"`returnLabelShippingFeeTransaction`\" - \"`reversalIssueRelatedRefundAndReplacement`\" - \"`reversalReturnLabelShippingFeeTransaction`\" - \"`lumpSumCorrectionTransaction`\" ", -"type": "string" -} -}, -"type": "object" -}, -"SettlementreportsListResponse": { -"id": "SettlementreportsListResponse", -"properties": { -"kind": { -"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#settlementreportsListResponse`\".", -"type": "string" -}, -"nextPageToken": { -"description": "The token for the retrieval of the next page of returns.", -"type": "string" -}, -"resources": { -"items": { -"$ref": "SettlementReport" -}, -"type": "array" -} -}, -"type": "object" -}, -"SettlementtransactionsListResponse": { -"id": "SettlementtransactionsListResponse", -"properties": { -"kind": { -"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#settlementtransactionsListResponse`\".", -"type": "string" -}, -"nextPageToken": { -"description": "The token for the retrieval of the next page of returns.", -"type": "string" -}, -"resources": { -"items": { -"$ref": "SettlementTransaction" -}, -"type": "array" -} -}, -"type": "object" -}, "ShippingSettings": { "description": "The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.", "id": "ShippingSettings", @@ -14109,7 +13787,7 @@ false "No issues available to review.", "Account will be automatically reviewed at the end of the grace period.", "Account is retired. Should not appear in MC.", -"Account was already reviewd." +"Account has already been reviewed. You can't request further reviews." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/datacatalog.v1.json b/googleapiclient/discovery_cache/documents/datacatalog.v1.json index 5073981e21..96490bfa96 100644 --- a/googleapiclient/discovery_cache/documents/datacatalog.v1.json +++ b/googleapiclient/discovery_cache/documents/datacatalog.v1.json @@ -172,9 +172,150 @@ } } }, +"organizations": { +"resources": { +"locations": { +"methods": { +"retrieveConfig": { +"description": "Retrieves the configuration related to the migration from Data Catalog to Dataplex for a specific organization, including all the projects under it which have a separate configuration set.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}:retrieveConfig", +"httpMethod": "GET", +"id": "datacatalog.organizations.locations.retrieveConfig", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The organization whose config is being retrieved.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:retrieveConfig", +"response": { +"$ref": "GoogleCloudDatacatalogV1OrganizationConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"retrieveEffectiveConfig": { +"description": "Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}:retrieveEffectiveConfig", +"httpMethod": "GET", +"id": "datacatalog.organizations.locations.retrieveEffectiveConfig", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource whose effective config is being retrieved.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:retrieveEffectiveConfig", +"response": { +"$ref": "GoogleCloudDatacatalogV1MigrationConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setConfig": { +"description": "Sets the configuration related to the migration to Dataplex for an organization or project.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}:setConfig", +"httpMethod": "POST", +"id": "datacatalog.organizations.locations.setConfig", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The organization or project whose config is being specified.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:setConfig", +"request": { +"$ref": "GoogleCloudDatacatalogV1SetConfigRequest" +}, +"response": { +"$ref": "GoogleCloudDatacatalogV1MigrationConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "projects": { "resources": { "locations": { +"methods": { +"retrieveEffectiveConfig": { +"description": "Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:retrieveEffectiveConfig", +"httpMethod": "GET", +"id": "datacatalog.projects.locations.retrieveEffectiveConfig", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource whose effective config is being retrieved.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:retrieveEffectiveConfig", +"response": { +"$ref": "GoogleCloudDatacatalogV1MigrationConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setConfig": { +"description": "Sets the configuration related to the migration to Dataplex for an organization or project.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:setConfig", +"httpMethod": "POST", +"id": "datacatalog.projects.locations.setConfig", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The organization or project whose config is being specified.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:setConfig", +"request": { +"$ref": "GoogleCloudDatacatalogV1SetConfigRequest" +}, +"response": { +"$ref": "GoogleCloudDatacatalogV1MigrationConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "entryGroups": { "methods": { @@ -2144,7 +2285,7 @@ } } }, -"revision": "20240630", +"revision": "20241021", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -3024,6 +3165,10 @@ "name": { "description": "Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.", "type": "string" +}, +"transferredToDataplex": { +"description": "Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Catalog Service. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset.", +"type": "boolean" } }, "type": "object" @@ -3411,6 +3556,41 @@ }, "type": "object" }, +"GoogleCloudDatacatalogV1MigrationConfig": { +"description": "The configuration related to the migration to Dataplex applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig.", +"id": "GoogleCloudDatacatalogV1MigrationConfig", +"properties": { +"catalogUiExperience": { +"description": "Opt-in status for the UI switch to Dataplex.", +"enum": [ +"CATALOG_UI_EXPERIENCE_UNSPECIFIED", +"CATALOG_UI_EXPERIENCE_ENABLED", +"CATALOG_UI_EXPERIENCE_DISABLED" +], +"enumDescriptions": [ +"Default value. The default UI is Dataplex.", +"The UI is Dataplex.", +"The UI is Data Catalog." +], +"type": "string" +}, +"tagTemplateMigration": { +"description": "Opt-in status for the migration of Tag Templates to Dataplex.", +"enum": [ +"TAG_TEMPLATE_MIGRATION_UNSPECIFIED", +"TAG_TEMPLATE_MIGRATION_ENABLED", +"TAG_TEMPLATE_MIGRATION_DISABLED" +], +"enumDescriptions": [ +"Default value. Migration of Tag Templates from Data Catalog to Dataplex is not performed.", +"Migration of Tag Templates from Data Catalog to Dataplex is enabled.", +"Migration of Tag Templates from Data Catalog to Dataplex is disabled." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDatacatalogV1ModelSpec": { "description": "Specification that applies to a model. Valid only for entries with the `MODEL` type.", "id": "GoogleCloudDatacatalogV1ModelSpec", @@ -3444,6 +3624,20 @@ }, "type": "object" }, +"GoogleCloudDatacatalogV1OrganizationConfig": { +"description": "The configuration related to the migration from Data Catalog to Dataplex that has been applied to an organization and any projects under it. It is the response message for RetrieveConfig.", +"id": "GoogleCloudDatacatalogV1OrganizationConfig", +"properties": { +"config": { +"additionalProperties": { +"$ref": "GoogleCloudDatacatalogV1MigrationConfig" +}, +"description": "Map of organizations and project resource names and their configuration. The format for the map keys is `organizations/{organizationId}` or `projects/{projectId}`.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDatacatalogV1PersonalDetails": { "description": "Entry metadata relevant only to the user and private to them.", "id": "GoogleCloudDatacatalogV1PersonalDetails", @@ -4031,6 +4225,41 @@ }, "type": "object" }, +"GoogleCloudDatacatalogV1SetConfigRequest": { +"description": "Request message for SetConfig.", +"id": "GoogleCloudDatacatalogV1SetConfigRequest", +"properties": { +"catalogUiExperience": { +"description": "Opt-in status for the UI switch to Dataplex.", +"enum": [ +"CATALOG_UI_EXPERIENCE_UNSPECIFIED", +"CATALOG_UI_EXPERIENCE_ENABLED", +"CATALOG_UI_EXPERIENCE_DISABLED" +], +"enumDescriptions": [ +"Default value. The default UI is Dataplex.", +"The UI is Dataplex.", +"The UI is Data Catalog." +], +"type": "string" +}, +"tagTemplateMigration": { +"description": "Opt-in status for the migration of Tag Templates to Dataplex.", +"enum": [ +"TAG_TEMPLATE_MIGRATION_UNSPECIFIED", +"TAG_TEMPLATE_MIGRATION_ENABLED", +"TAG_TEMPLATE_MIGRATION_DISABLED" +], +"enumDescriptions": [ +"Default value. Migration of Tag Templates from Data Catalog to Dataplex is not performed.", +"Migration of Tag Templates from Data Catalog to Dataplex is enabled.", +"Migration of Tag Templates from Data Catalog to Dataplex is disabled." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDatacatalogV1SqlDatabaseSystemSpec": { "description": "Specification that applies to entries that are part `SQL_DATABASE` system (user_specified_type)", "id": "GoogleCloudDatacatalogV1SqlDatabaseSystemSpec", @@ -4123,6 +4352,26 @@ "description": "Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`.", "type": "string" }, +"dataplexTransferStatus": { +"description": "Output only. Denotes the transfer status of the Tag Template.", +"enum": [ +"DATAPLEX_TRANSFER_STATUS_UNSPECIFIED", +"MIGRATED", +"TRANSFERRED" +], +"enumDeprecated": [ +false, +true, +false +], +"enumDescriptions": [ +"Default value. TagTemplate and its tags are only visible and editable in DataCatalog.", +"TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in DataCatalog, read-only in Dataplex. Deprecated: Individual TagTemplate migration is deprecated in favor of organization or project wide TagTemplate migration opt-in.", +"TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in Dataplex, read-only in DataCatalog." +], +"readOnly": true, +"type": "string" +}, "fields": { "additionalProperties": { "$ref": "GoogleCloudDatacatalogV1TagField" @@ -4209,15 +4458,18 @@ "description": "Optional. Transfer status of the TagTemplate", "enum": [ "DATAPLEX_TRANSFER_STATUS_UNSPECIFIED", -"MIGRATED" +"MIGRATED", +"TRANSFERRED" ], "enumDeprecated": [ false, -true +true, +false ], "enumDescriptions": [ "Default value. TagTemplate and its tags are only visible and editable in DataCatalog.", -"TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in DataCatalog, read-only in Dataplex. Deprecated: Individual TagTemplate migration is deprecated in favor of organization or project wide TagTemplate migration opt-in." +"TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in DataCatalog, read-only in Dataplex. Deprecated: Individual TagTemplate migration is deprecated in favor of organization or project wide TagTemplate migration opt-in.", +"TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in Dataplex, read-only in DataCatalog." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json b/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json index 216cfabf90..f788c2375a 100644 --- a/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json @@ -1813,7 +1813,7 @@ } } }, -"revision": "20240630", +"revision": "20241021", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -3171,6 +3171,26 @@ "description": "Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`.", "type": "string" }, +"dataplexTransferStatus": { +"description": "Output only. Denotes the transfer status of the Tag Template.", +"enum": [ +"DATAPLEX_TRANSFER_STATUS_UNSPECIFIED", +"MIGRATED", +"TRANSFERRED" +], +"enumDeprecated": [ +false, +true, +false +], +"enumDescriptions": [ +"Default value. TagTemplate and its tags are only visible and editable in DataCatalog.", +"TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in DataCatalog, read-only in Dataplex. Deprecated: Individual TagTemplate migration is deprecated in favor of organization or project wide TagTemplate migration opt-in.", +"TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in Dataplex, read-only in DataCatalog." +], +"readOnly": true, +"type": "string" +}, "fields": { "additionalProperties": { "$ref": "GoogleCloudDatacatalogV1TagField" diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json index c131207803..bc5177e4d4 100644 --- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json +++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json @@ -2208,7 +2208,7 @@ } } }, -"revision": "20240817", +"revision": "20241014", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -3446,7 +3446,7 @@ "type": "object" }, "FlexTemplateRuntimeEnvironment": { -"description": "The environment values to be set at runtime for flex template. LINT.IfChange", +"description": "The environment values to be set at runtime for flex template.", "id": "FlexTemplateRuntimeEnvironment", "properties": { "additionalExperiments": { @@ -5485,7 +5485,7 @@ false "type": "object" }, "RuntimeEnvironment": { -"description": "The environment values to set at runtime. LINT.IfChange", +"description": "The environment values to set at runtime.", "id": "RuntimeEnvironment", "properties": { "additionalExperiments": { diff --git a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json index 7f354660c2..64bdcd514f 100644 --- a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json @@ -467,7 +467,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. Page token received from a previous `FetchRepositoryHistory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchRepositoryHistory` must match the call that provided the page token.", +"description": "Optional. Page token received from a previous `FetchRepositoryHistory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchRepositoryHistory`, with the exception of `page_size`, must match the call that provided the page token.", "location": "query", "type": "string" } @@ -587,7 +587,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. Page token received from a previous `ListRepositories` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepositories` must match the call that provided the page token.", +"description": "Optional. Page token received from a previous `ListRepositories` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepositories`, with the exception of `page_size`, must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -669,7 +669,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. Page token received from a previous `QueryRepositoryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryRepositoryDirectoryContents` must match the call that provided the page token.", +"description": "Optional. Page token received from a previous `QueryRepositoryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -989,7 +989,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. Page token received from a previous `ListCompilationResults` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCompilationResults` must match the call that provided the page token.", +"description": "Optional. Page token received from a previous `ListCompilationResults` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCompilationResults`, with the exception of `page_size`, must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -1037,7 +1037,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. Page token received from a previous `QueryCompilationResultActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryCompilationResultActions` must match the call that provided the page token.", +"description": "Optional. Page token received from a previous `QueryCompilationResultActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryCompilationResultActions`, with the exception of `page_size`, must match the call that provided the page token.", "location": "query", "type": "string" } @@ -1153,7 +1153,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs` must match the call that provided the page token.", +"description": "Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -1310,7 +1310,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. Page token received from a previous `ListWorkflowConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowConfigs` must match the call that provided the page token.", +"description": "Optional. Page token received from a previous `ListWorkflowConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowConfigs`, with the exception of `page_size`, must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -1500,7 +1500,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. Page token received from a previous `ListWorkflowInvocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowInvocations` must match the call that provided the page token.", +"description": "Optional. Page token received from a previous `ListWorkflowInvocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowInvocations`, with the exception of `page_size`, must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -1543,7 +1543,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. Page token received from a previous `QueryWorkflowInvocationActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryWorkflowInvocationActions` must match the call that provided the page token.", +"description": "Optional. Page token received from a previous `QueryWorkflowInvocationActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryWorkflowInvocationActions`, with the exception of `page_size`, must match the call that provided the page token.", "location": "query", "type": "string" } @@ -1841,7 +1841,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. Page token received from a previous `ListWorkspaces` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkspaces` must match the call that provided the page token.", +"description": "Optional. Page token received from a previous `ListWorkspaces` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkspaces`, with the exception of `page_size`, must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -2017,7 +2017,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. Page token received from a previous `QueryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDirectoryContents` must match the call that provided the page token.", +"description": "Optional. Page token received from a previous `QueryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -2182,7 +2182,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. Page token received from a previous `SearchFilesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchFilesRequest` must match the call that provided the page token.", +"description": "Optional. Page token received from a previous `SearchFilesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchFilesRequest`, with the exception of `page_size`, must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -2295,7 +2295,7 @@ } } }, -"revision": "20240824", +"revision": "20241020", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "Assertion": { @@ -2655,10 +2655,6 @@ "$ref": "Target", "description": "The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result." }, -"dataPreparation": { -"$ref": "DataPreparation", -"description": "The data preparation executed by this action." -}, "declaration": { "$ref": "Declaration", "description": "The declaration declared by this action." @@ -2735,36 +2731,6 @@ }, "type": "object" }, -"DataPreparation": { -"description": "Defines a compiled Data Preparation entity", -"id": "DataPreparation", -"properties": { -"contents": { -"description": "The data preparation definition, stored as a binary encoded proto.", -"format": "byte", -"type": "string" -}, -"dependencyTargets": { -"description": "A list of actions that this action depends on.", -"items": { -"$ref": "Target" -}, -"type": "array" -}, -"disabled": { -"description": "Whether this action is disabled (i.e. should not be run).", -"type": "boolean" -}, -"tags": { -"description": "Arbitrary, user-defined tags on this action.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "Declaration": { "description": "Represents a relation which is not managed by Dataform but which may be referenced by Dataform actions.", "id": "Declaration", @@ -3776,7 +3742,7 @@ "type": "string" }, "recentScheduledReleaseRecords": { -"description": "Output only. Records of the 10 most recent scheduled release attempts, ordered in in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.", +"description": "Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.", "items": { "$ref": "ScheduledReleaseRecord" }, @@ -3840,7 +3806,7 @@ "description": "Optional. If set, configures this repository to be linked to a Git remote." }, "kmsKeyName": { -"description": "Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]`", +"description": "Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`", "type": "string" }, "labels": { @@ -4116,7 +4082,7 @@ "type": "string" }, "recentScheduledExecutionRecords": { -"description": "Output only. Records of the 10 most recent scheduled execution attempts, ordered in in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.", +"description": "Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.", "items": { "$ref": "ScheduledExecutionRecord" }, @@ -4264,6 +4230,12 @@ "description": "Represents a Dataform Git workspace.", "id": "Workspace", "properties": { +"createTime": { +"description": "Output only. The timestamp of when the workspace was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "dataEncryptionState": { "$ref": "DataEncryptionState", "description": "Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key.", diff --git a/googleapiclient/discovery_cache/documents/datalineage.v1.json b/googleapiclient/discovery_cache/documents/datalineage.v1.json index 90ad2b6641..80c8d30cdb 100644 --- a/googleapiclient/discovery_cache/documents/datalineage.v1.json +++ b/googleapiclient/discovery_cache/documents/datalineage.v1.json @@ -15,6 +15,233 @@ "description": "", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/data-catalog", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datalineage.us-west8.rep.googleapis.com/", +"location": "us-west8" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -798,7 +1025,7 @@ } } }, -"revision": "20240902", +"revision": "20241018", "rootUrl": "https://datalineage.googleapis.com/", "schemas": { "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest": { @@ -1052,7 +1279,7 @@ "type": "string" }, "sourceType": { -"description": "Type of the source. Use of a source_type other than `CUSTOM` for process creation or updating is highly discouraged, and may be restricted in the future without notice.", +"description": "Type of the source. Use of a source_type other than `CUSTOM` for process creation or updating is highly discouraged. It may cause additional billing costs and be restricted in the future without notice.", "enum": [ "SOURCE_TYPE_UNSPECIFIED", "CUSTOM", diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1.json b/googleapiclient/discovery_cache/documents/datamigration.v1.json index ac08244af9..a61da61531 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1.json @@ -2218,7 +2218,7 @@ } } }, -"revision": "20241006", +"revision": "20241022", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -2952,6 +2952,20 @@ ], "type": "string" }, +"role": { +"description": "Optional. The connection profile role.", +"enum": [ +"ROLE_UNSPECIFIED", +"SOURCE", +"DESTINATION" +], +"enumDescriptions": [ +"The role is unspecified.", +"The role is source.", +"The role is destination." +], +"type": "string" +}, "sqlserver": { "$ref": "SqlServerConnectionProfile", "description": "Connection profile for a SQL Server data source." @@ -6076,12 +6090,16 @@ "enum": [ "SSL_TYPE_UNSPECIFIED", "SERVER_ONLY", -"SERVER_CLIENT" +"SERVER_CLIENT", +"REQUIRED", +"NONE" ], "enumDescriptions": [ "Unspecified.", "Only 'ca_certificate' specified.", -"Both server ('ca_certificate'), and client ('client_key', 'client_certificate') specified." +"Both server ('ca_certificate'), and client ('client_key', 'client_certificate') specified.", +"Mandates SSL encryption for all connections. This doesn\u2019t require certificate verification.", +"Connection is not encrypted." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index 82ef0efa91..6ead08fa2b 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -15,6 +15,233 @@ "description": "Dataplex API is used to manage the lifecycle of data lakes.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/dataplex/docs", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataplex.us-west8.rep.googleapis.com/", +"location": "us-west8" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -5997,7 +6224,7 @@ } } }, -"revision": "20240925", +"revision": "20241019", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -6265,6 +6492,10 @@ "format": "google-datetime", "type": "string" }, +"dataVersion": { +"description": "The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).", +"type": "string" +}, "updateTime": { "description": "The time the aspect was last updated in the source system.", "format": "google-datetime", @@ -7114,6 +7345,142 @@ }, "type": "object" }, +"GoogleCloudDataplexV1DataDiscoveryResult": { +"description": "The output of a data discovery scan.", +"id": "GoogleCloudDataplexV1DataDiscoveryResult", +"properties": { +"bigqueryPublishing": { +"$ref": "GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing", +"description": "Output only. Configuration for metadata publishing.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing": { +"description": "Describes BigQuery publishing configurations.", +"id": "GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing", +"properties": { +"dataset": { +"description": "Output only. The BigQuery dataset to publish to. It takes the form projects/{project_id}/datasets/{dataset_id}. If not set, the service creates a default publishing dataset.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1DataDiscoverySpec": { +"description": "Spec for a data discovery scan.", +"id": "GoogleCloudDataplexV1DataDiscoverySpec", +"properties": { +"bigqueryPublishingConfig": { +"$ref": "GoogleCloudDataplexV1DataDiscoverySpecBigQueryPublishingConfig", +"description": "Optional. Configuration for metadata publishing." +}, +"storageConfig": { +"$ref": "GoogleCloudDataplexV1DataDiscoverySpecStorageConfig", +"description": "Cloud Storage related configurations." +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1DataDiscoverySpecBigQueryPublishingConfig": { +"description": "Describes BigQuery publishing configurations.", +"id": "GoogleCloudDataplexV1DataDiscoverySpecBigQueryPublishingConfig", +"properties": { +"connection": { +"description": "Optional. The BigQuery connection used to create BigLake tables. Must be in the form projects/{project_id}/locations/{location_id}/connections/{connection_id}", +"type": "string" +}, +"tableType": { +"description": "Optional. Determines whether to publish discovered tables as BigLake external tables or non-BigLake external tables.", +"enum": [ +"TABLE_TYPE_UNSPECIFIED", +"EXTERNAL", +"BIGLAKE" +], +"enumDescriptions": [ +"Table type unspecified.", +"Default. Discovered tables are published as BigQuery external tables whose data is accessed using the credentials of the user querying the table.", +"Discovered tables are published as BigLake external tables whose data is accessed using the credentials of the associated BigQuery connection." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1DataDiscoverySpecStorageConfig": { +"description": "Configurations related to Cloud Storage as the data source.", +"id": "GoogleCloudDataplexV1DataDiscoverySpecStorageConfig", +"properties": { +"csvOptions": { +"$ref": "GoogleCloudDataplexV1DataDiscoverySpecStorageConfigCsvOptions", +"description": "Optional. Configuration for CSV data." +}, +"excludePatterns": { +"description": "Optional. Defines the data to exclude during discovery. Provide a list of patterns that identify the data to exclude. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names.", +"items": { +"type": "string" +}, +"type": "array" +}, +"includePatterns": { +"description": "Optional. Defines the data to include during discovery when only a subset of the data should be considered. Provide a list of patterns that identify the data to include. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names.", +"items": { +"type": "string" +}, +"type": "array" +}, +"jsonOptions": { +"$ref": "GoogleCloudDataplexV1DataDiscoverySpecStorageConfigJsonOptions", +"description": "Optional. Configuration for JSON data." +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1DataDiscoverySpecStorageConfigCsvOptions": { +"description": "Describes CSV and similar semi-structured data formats.", +"id": "GoogleCloudDataplexV1DataDiscoverySpecStorageConfigCsvOptions", +"properties": { +"delimiter": { +"description": "Optional. The delimiter that is used to separate values. The default is , (comma).", +"type": "string" +}, +"encoding": { +"description": "Optional. The character encoding of the data. The default is UTF-8.", +"type": "string" +}, +"headerRows": { +"description": "Optional. The number of rows to interpret as header rows that should be skipped when reading data rows.", +"format": "int32", +"type": "integer" +}, +"quote": { +"description": "Optional. The character used to quote column values. Accepts \" (double quotation mark) or ' (single quotation mark). If unspecified, defaults to \" (double quotation mark).", +"type": "string" +}, +"typeInferenceDisabled": { +"description": "Optional. Whether to disable the inference of data types for CSV data. If true, all columns are registered as strings.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1DataDiscoverySpecStorageConfigJsonOptions": { +"description": "Describes JSON data format.", +"id": "GoogleCloudDataplexV1DataDiscoverySpecStorageConfigJsonOptions", +"properties": { +"encoding": { +"description": "Optional. The character encoding of the data. The default is UTF-8.", +"type": "string" +}, +"typeInferenceDisabled": { +"description": "Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean).", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDataplexV1DataProfileResult": { "description": "DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result.", "id": "GoogleCloudDataplexV1DataProfileResult", @@ -7453,7 +7820,7 @@ "id": "GoogleCloudDataplexV1DataQualityDimension", "properties": { "name": { -"description": "The dimension name a rule belongs to. Supported dimensions are \"COMPLETENESS\", \"ACCURACY\", \"CONSISTENCY\", \"VALIDITY\", \"UNIQUENESS\", \"INTEGRITY\"", +"description": "The dimension name a rule belongs to. Supported dimensions are \"COMPLETENESS\", \"ACCURACY\", \"CONSISTENCY\", \"VALIDITY\", \"UNIQUENESS\", \"FRESHNESS\", \"VOLUME\"", "type": "string" } }, @@ -7588,7 +7955,7 @@ "type": "string" }, "dimension": { -"description": "Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are \"COMPLETENESS\", \"ACCURACY\", \"CONSISTENCY\", \"VALIDITY\", \"UNIQUENESS\", \"INTEGRITY\"", +"description": "Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are \"COMPLETENESS\", \"ACCURACY\", \"CONSISTENCY\", \"VALIDITY\", \"UNIQUENESS\", \"FRESHNESS\", \"VOLUME\"", "type": "string" }, "ignoreNull": { @@ -8060,23 +8427,32 @@ "$ref": "GoogleCloudDataplexV1DataSource", "description": "Required. The data source for DataScan." }, +"dataDiscoveryResult": { +"$ref": "GoogleCloudDataplexV1DataDiscoveryResult", +"description": "Output only. The result of a data discovery scan.", +"readOnly": true +}, +"dataDiscoverySpec": { +"$ref": "GoogleCloudDataplexV1DataDiscoverySpec", +"description": "Settings for a data discovery scan." +}, "dataProfileResult": { "$ref": "GoogleCloudDataplexV1DataProfileResult", -"description": "Output only. The result of the data profile scan.", +"description": "Output only. The result of a data profile scan.", "readOnly": true }, "dataProfileSpec": { "$ref": "GoogleCloudDataplexV1DataProfileSpec", -"description": "DataProfileScan related setting." +"description": "Settings for a data profile scan." }, "dataQualityResult": { "$ref": "GoogleCloudDataplexV1DataQualityResult", -"description": "Output only. The result of the data quality scan.", +"description": "Output only. The result of a data quality scan.", "readOnly": true }, "dataQualitySpec": { "$ref": "GoogleCloudDataplexV1DataQualitySpec", -"description": "DataQualityScan related setting." +"description": "Settings for a data quality scan." }, "description": { "description": "Optional. Description of the scan. Must be between 1-1024 characters.", @@ -8131,12 +8507,14 @@ "enum": [ "DATA_SCAN_TYPE_UNSPECIFIED", "DATA_QUALITY", -"DATA_PROFILE" +"DATA_PROFILE", +"DATA_DISCOVERY" ], "enumDescriptions": [ -"The DataScan type is unspecified.", -"Data Quality scan.", -"Data Profile scan." +"The data scan type is unspecified.", +"Data quality scan.", +"Data profile scan.", +"Data discovery scan." ], "readOnly": true, "type": "string" @@ -8452,24 +8830,34 @@ "readOnly": true, "type": "string" }, +"dataDiscoveryResult": { +"$ref": "GoogleCloudDataplexV1DataDiscoveryResult", +"description": "Output only. The result of a data discovery scan.", +"readOnly": true +}, +"dataDiscoverySpec": { +"$ref": "GoogleCloudDataplexV1DataDiscoverySpec", +"description": "Output only. Settings for a data discovery scan.", +"readOnly": true +}, "dataProfileResult": { "$ref": "GoogleCloudDataplexV1DataProfileResult", -"description": "Output only. The result of the data profile scan.", +"description": "Output only. The result of a data profile scan.", "readOnly": true }, "dataProfileSpec": { "$ref": "GoogleCloudDataplexV1DataProfileSpec", -"description": "Output only. DataProfileScan related setting.", +"description": "Output only. Settings for a data profile scan.", "readOnly": true }, "dataQualityResult": { "$ref": "GoogleCloudDataplexV1DataQualityResult", -"description": "Output only. The result of the data quality scan.", +"description": "Output only. The result of a data quality scan.", "readOnly": true }, "dataQualitySpec": { "$ref": "GoogleCloudDataplexV1DataQualitySpec", -"description": "Output only. DataQualityScan related setting.", +"description": "Output only. Settings for a data quality scan.", "readOnly": true }, "endTime": { @@ -8522,12 +8910,14 @@ "enum": [ "DATA_SCAN_TYPE_UNSPECIFIED", "DATA_QUALITY", -"DATA_PROFILE" +"DATA_PROFILE", +"DATA_DISCOVERY" ], "enumDescriptions": [ -"The DataScan type is unspecified.", -"Data Quality scan.", -"Data Profile scan." +"The data scan type is unspecified.", +"Data quality scan.", +"Data profile scan.", +"Data discovery scan." ], "readOnly": true, "type": "string" @@ -8694,6 +9084,10 @@ "description": "Details about the action.", "id": "GoogleCloudDataplexV1DiscoveryEventActionDetails", "properties": { +"issue": { +"description": "The human readable issue associated with the action.", +"type": "string" +}, "type": { "description": "The type of action. Eg. IncompatibleDataSchema, InvalidDataFormat", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/datastore.v1.json b/googleapiclient/discovery_cache/documents/datastore.v1.json index 6b94f6ce4e..288f447223 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1.json @@ -654,7 +654,7 @@ } } }, -"revision": "20240626", +"revision": "20241018", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { @@ -1064,6 +1064,51 @@ }, "type": "object" }, +"FindNearest": { +"description": "Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries.", +"id": "FindNearest", +"properties": { +"distanceMeasure": { +"description": "Required. The Distance Measure to use, required.", +"enum": [ +"DISTANCE_MEASURE_UNSPECIFIED", +"EUCLIDEAN", +"COSINE", +"DOT_PRODUCT" +], +"enumDescriptions": [ +"Should not be set.", +"Measures the EUCLIDEAN distance between the vectors. See [Euclidean](https://en.wikipedia.org/wiki/Euclidean_distance) to learn more. The resulting distance decreases the more similar two vectors are.", +"COSINE distance compares vectors based on the angle between them, which allows you to measure similarity that isn't based on the vectors magnitude. We recommend using DOT_PRODUCT with unit normalized vectors instead of COSINE distance, which is mathematically equivalent with better performance. See [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) to learn more about COSINE similarity and COSINE distance. The resulting COSINE distance decreases the more similar two vectors are.", +"Similar to cosine but is affected by the magnitude of the vectors. See [Dot Product](https://en.wikipedia.org/wiki/Dot_product) to learn more. The resulting distance increases the more similar two vectors are." +], +"type": "string" +}, +"distanceResultProperty": { +"description": "Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to entity property limitations.", +"type": "string" +}, +"distanceThreshold": { +"description": "Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold", +"format": "double", +"type": "number" +}, +"limit": { +"description": "Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100.", +"format": "int32", +"type": "integer" +}, +"queryVector": { +"$ref": "Value", +"description": "Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions." +}, +"vectorProperty": { +"$ref": "PropertyReference", +"description": "Required. An indexed vector property to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned." +} +}, +"type": "object" +}, "GoogleDatastoreAdminV1CommonMetadata": { "description": "Metadata common to all Datastore Admin operations.", "id": "GoogleDatastoreAdminV1CommonMetadata", @@ -1937,6 +1982,20 @@ "format": "int64", "type": "string" }, +"conflictResolutionStrategy": { +"description": "The strategy to use when a conflict is detected. Defaults to `SERVER_VALUE`. If this is set, then `conflict_detection_strategy` must also be set.", +"enum": [ +"STRATEGY_UNSPECIFIED", +"SERVER_VALUE", +"FAIL" +], +"enumDescriptions": [ +"Unspecified. Defaults to `SERVER_VALUE`.", +"The server entity is kept.", +"The whole commit request fails." +], +"type": "string" +}, "delete": { "$ref": "Key", "description": "The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only." @@ -1949,6 +2008,13 @@ "$ref": "PropertyMask", "description": "The properties to write in this mutation. None of the properties in the mask may have a reserved name, except for `__key__`. This field is ignored for `delete`. If the entity already exists, only properties referenced in the mask are updated, others are left untouched. Properties referenced in the mask but not in the entity are deleted." }, +"propertyTransforms": { +"description": "Optional. The transforms to perform on the entity. This field can be set only when the operation is `insert`, `update`, or `upsert`. If present, the transforms are be applied to the entity regardless of the property mask, in order, after the operation.", +"items": { +"$ref": "PropertyTransform" +}, +"type": "array" +}, "update": { "$ref": "Entity", "description": "The entity to update. The entity must already exist. Must have a complete key path." @@ -1982,6 +2048,13 @@ "$ref": "Key", "description": "The automatically allocated key. Set only when the mutation allocated a key." }, +"transformResults": { +"description": "The results of applying each PropertyTransform, in the same order of the request.", +"items": { +"$ref": "Value" +}, +"type": "array" +}, "updateTime": { "description": "The update time of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the timestamp will be the update timestamp of the current entity. This field will not be set after a 'delete'.", "format": "google-datetime", @@ -2156,8 +2229,51 @@ }, "type": "object" }, +"PropertyTransform": { +"description": "A transformation of an entity property.", +"id": "PropertyTransform", +"properties": { +"appendMissingElements": { +"$ref": "ArrayValue", +"description": "Appends the given elements in order if they are not already present in the current property value. If the property is not an array, or if the property does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and the null value is equal to the null value. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform result will be the null value." +}, +"increment": { +"$ref": "Value", +"description": "Adds the given value to the property's current value. This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the given value. If either of the given value or the current property value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follows IEEE 754 semantics. If there is positive/negative integer overflow, the property is resolved to the largest magnitude positive/negative integer." +}, +"maximum": { +"$ref": "Value", +"description": "Sets the property to the maximum of its current value and the given value. This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the given value. If a maximum operation is applied where the property and the input value are of mixed types (that is - one is an integer and one is a double) the property takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN." +}, +"minimum": { +"$ref": "Value", +"description": "Sets the property to the minimum of its current value and the given value. This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the input value. If a minimum operation is applied where the property and the input value are of mixed types (that is - one is an integer and one is a double) the property takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN." +}, +"property": { +"description": "Optional. The name of the property. Property paths (a list of property names separated by dots (`.`)) may be used to refer to properties inside entity values. For example `foo.bar` means the property `bar` inside the entity property `foo`. If a property name contains a dot `.` or a backlslash `\\`, then that name must be escaped.", +"type": "string" +}, +"removeAllFromArray": { +"$ref": "ArrayValue", +"description": "Removes all of the given elements from the array in the property. If the property is not an array, or if the property does not yet exist, it is set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and the null value is equal to the null value. This will remove all equivalent values if there are duplicates. The corresponding transform result will be the null value." +}, +"setToServerValue": { +"description": "Sets the property to the given server value.", +"enum": [ +"SERVER_VALUE_UNSPECIFIED", +"REQUEST_TIME" +], +"enumDescriptions": [ +"Unspecified. This value must not be used.", +"The time at which the server processed the request, with millisecond precision. If used on multiple properties (same or different entities) in a transaction, all the properties will get the same server timestamp." +], +"type": "string" +} +}, +"type": "object" +}, "Query": { -"description": "A query for entities.", +"description": "A query for entities. The query stages are executed in the following order: 1. kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6. limit 7. find_nearest", "id": "Query", "properties": { "distinctOn": { @@ -2176,6 +2292,10 @@ "$ref": "Filter", "description": "The filter to apply." }, +"findNearest": { +"$ref": "FindNearest", +"description": "Optional. A potential Nearest Neighbors Search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector." +}, "kind": { "description": "The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.", "items": { diff --git a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json index 5553cc5775..2505dcb740 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json @@ -336,7 +336,7 @@ } } }, -"revision": "20240626", +"revision": "20241018", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { @@ -724,6 +724,51 @@ }, "type": "object" }, +"FindNearest": { +"description": "Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries.", +"id": "FindNearest", +"properties": { +"distanceMeasure": { +"description": "Required. The Distance Measure to use, required.", +"enum": [ +"DISTANCE_MEASURE_UNSPECIFIED", +"EUCLIDEAN", +"COSINE", +"DOT_PRODUCT" +], +"enumDescriptions": [ +"Should not be set.", +"Measures the EUCLIDEAN distance between the vectors. See [Euclidean](https://en.wikipedia.org/wiki/Euclidean_distance) to learn more. The resulting distance decreases the more similar two vectors are.", +"COSINE distance compares vectors based on the angle between them, which allows you to measure similarity that isn't based on the vectors magnitude. We recommend using DOT_PRODUCT with unit normalized vectors instead of COSINE distance, which is mathematically equivalent with better performance. See [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) to learn more about COSINE similarity and COSINE distance. The resulting COSINE distance decreases the more similar two vectors are.", +"Similar to cosine but is affected by the magnitude of the vectors. See [Dot Product](https://en.wikipedia.org/wiki/Dot_product) to learn more. The resulting distance increases the more similar two vectors are." +], +"type": "string" +}, +"distanceResultProperty": { +"description": "Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to entity property limitations.", +"type": "string" +}, +"distanceThreshold": { +"description": "Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold", +"format": "double", +"type": "number" +}, +"limit": { +"description": "Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100.", +"format": "int32", +"type": "integer" +}, +"queryVector": { +"$ref": "Value", +"description": "Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions." +}, +"vectorProperty": { +"$ref": "PropertyReference", +"description": "Required. An indexed vector property to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned." +} +}, +"type": "object" +}, "GoogleDatastoreAdminV1CommonMetadata": { "description": "Metadata common to all Datastore Admin operations.", "id": "GoogleDatastoreAdminV1CommonMetadata", @@ -1387,6 +1432,20 @@ "format": "int64", "type": "string" }, +"conflictResolutionStrategy": { +"description": "The strategy to use when a conflict is detected. Defaults to `SERVER_VALUE`. If this is set, then `conflict_detection_strategy` must also be set.", +"enum": [ +"STRATEGY_UNSPECIFIED", +"SERVER_VALUE", +"FAIL" +], +"enumDescriptions": [ +"Unspecified. Defaults to `SERVER_VALUE`.", +"The server entity is kept.", +"The whole commit request fails." +], +"type": "string" +}, "delete": { "$ref": "Key", "description": "The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only." @@ -1399,6 +1458,13 @@ "$ref": "PropertyMask", "description": "The properties to write in this mutation. None of the properties in the mask may have a reserved name, except for `__key__`. This field is ignored for `delete`. If the entity already exists, only properties referenced in the mask are updated, others are left untouched. Properties referenced in the mask but not in the entity are deleted." }, +"propertyTransforms": { +"description": "Optional. The transforms to perform on the entity. This field can be set only when the operation is `insert`, `update`, or `upsert`. If present, the transforms are be applied to the entity regardless of the property mask, in order, after the operation.", +"items": { +"$ref": "PropertyTransform" +}, +"type": "array" +}, "update": { "$ref": "Entity", "description": "The entity to update. The entity must already exist. Must have a complete key path." @@ -1432,6 +1498,13 @@ "$ref": "Key", "description": "The automatically allocated key. Set only when the mutation allocated a key." }, +"transformResults": { +"description": "The results of applying each PropertyTransform, in the same order of the request.", +"items": { +"$ref": "Value" +}, +"type": "array" +}, "updateTime": { "description": "The update time of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the timestamp will be the update timestamp of the current entity. This field will not be set after a 'delete'.", "format": "google-datetime", @@ -1602,8 +1675,51 @@ }, "type": "object" }, +"PropertyTransform": { +"description": "A transformation of an entity property.", +"id": "PropertyTransform", +"properties": { +"appendMissingElements": { +"$ref": "ArrayValue", +"description": "Appends the given elements in order if they are not already present in the current property value. If the property is not an array, or if the property does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and the null value is equal to the null value. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform result will be the null value." +}, +"increment": { +"$ref": "Value", +"description": "Adds the given value to the property's current value. This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the given value. If either of the given value or the current property value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follows IEEE 754 semantics. If there is positive/negative integer overflow, the property is resolved to the largest magnitude positive/negative integer." +}, +"maximum": { +"$ref": "Value", +"description": "Sets the property to the maximum of its current value and the given value. This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the given value. If a maximum operation is applied where the property and the input value are of mixed types (that is - one is an integer and one is a double) the property takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN." +}, +"minimum": { +"$ref": "Value", +"description": "Sets the property to the minimum of its current value and the given value. This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the input value. If a minimum operation is applied where the property and the input value are of mixed types (that is - one is an integer and one is a double) the property takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN." +}, +"property": { +"description": "Optional. The name of the property. Property paths (a list of property names separated by dots (`.`)) may be used to refer to properties inside entity values. For example `foo.bar` means the property `bar` inside the entity property `foo`. If a property name contains a dot `.` or a backlslash `\\`, then that name must be escaped.", +"type": "string" +}, +"removeAllFromArray": { +"$ref": "ArrayValue", +"description": "Removes all of the given elements from the array in the property. If the property is not an array, or if the property does not yet exist, it is set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and the null value is equal to the null value. This will remove all equivalent values if there are duplicates. The corresponding transform result will be the null value." +}, +"setToServerValue": { +"description": "Sets the property to the given server value.", +"enum": [ +"SERVER_VALUE_UNSPECIFIED", +"REQUEST_TIME" +], +"enumDescriptions": [ +"Unspecified. This value must not be used.", +"The time at which the server processed the request, with millisecond precision. If used on multiple properties (same or different entities) in a transaction, all the properties will get the same server timestamp." +], +"type": "string" +} +}, +"type": "object" +}, "Query": { -"description": "A query for entities.", +"description": "A query for entities. The query stages are executed in the following order: 1. kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6. limit 7. find_nearest", "id": "Query", "properties": { "distinctOn": { @@ -1622,6 +1738,10 @@ "$ref": "Filter", "description": "The filter to apply." }, +"findNearest": { +"$ref": "FindNearest", +"description": "Optional. A potential Nearest Neighbors Search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector." +}, "kind": { "description": "The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.", "items": { diff --git a/googleapiclient/discovery_cache/documents/developerconnect.v1.json b/googleapiclient/discovery_cache/documents/developerconnect.v1.json index 7ca8ffc170..9fa9727373 100644 --- a/googleapiclient/discovery_cache/documents/developerconnect.v1.json +++ b/googleapiclient/discovery_cache/documents/developerconnect.v1.json @@ -473,7 +473,7 @@ "type": "string" }, "updateMask": { -"description": "Optional. Required. Field mask is used to specify the fields to be overwritten in the Connection resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"description": "Required. Field mask is used to specify the fields to be overwritten in the Connection resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -494,6 +494,31 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"processGitHubEnterpriseWebhook": { +"description": "ProcessGitHubEnterpriseWebhook is called by the external GitHub Enterprise instances for notifying events.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections:processGitHubEnterpriseWebhook", +"httpMethod": "POST", +"id": "developerconnect.projects.locations.connections.processGitHubEnterpriseWebhook", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Project and location where the webhook will be received. Format: `projects/*/locations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/connections:processGitHubEnterpriseWebhook", +"request": { +"$ref": "ProcessGitHubEnterpriseWebhookRequest" +}, +"response": { +"$ref": "Empty" +} } }, "resources": { @@ -759,6 +784,59 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"processGitLabEnterpriseWebhook": { +"description": "ProcessGitLabEnterpriseWebhook is called by the external GitLab Enterprise instances for notifying events.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks/{gitRepositoryLinksId}:processGitLabEnterpriseWebhook", +"httpMethod": "POST", +"id": "developerconnect.projects.locations.connections.gitRepositoryLinks.processGitLabEnterpriseWebhook", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The GitRepositoryLink resource where the webhook will be received. Format: `projects/*/locations/*/connections/*/gitRepositoryLinks/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/gitRepositoryLinks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:processGitLabEnterpriseWebhook", +"request": { +"$ref": "ProcessGitLabEnterpriseWebhookRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"processGitLabWebhook": { +"description": "ProcessGitLabWebhook is called by the GitLab.com for notifying events.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks/{gitRepositoryLinksId}:processGitLabWebhook", +"httpMethod": "POST", +"id": "developerconnect.projects.locations.connections.gitRepositoryLinks.processGitLabWebhook", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The GitRepositoryLink resource where the webhook will be received. Format: `projects/*/locations/*/connections/*/gitRepositoryLinks/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/gitRepositoryLinks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:processGitLabWebhook", +"request": { +"$ref": "ProcessGitLabWebhookRequest" +}, +"response": { +"$ref": "Empty" +} } } } @@ -892,7 +970,7 @@ } } }, -"revision": "20240926", +"revision": "20241017", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1314,6 +1392,33 @@ }, "type": "object" }, +"HttpBody": { +"description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", +"id": "HttpBody", +"properties": { +"contentType": { +"description": "The HTTP Content-Type header value specifying the content type of the body.", +"type": "string" +}, +"data": { +"description": "The HTTP request/response body as raw binary.", +"format": "byte", +"type": "string" +}, +"extensions": { +"description": "Application specific response metadata. Must be set in the first response for streaming APIs.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +} +}, +"type": "object" +}, "Installation": { "description": "Represents an installation of the GitHub App.", "id": "Installation", @@ -1596,6 +1701,39 @@ }, "type": "object" }, +"ProcessGitHubEnterpriseWebhookRequest": { +"description": "RPC request object accepted by the ProcessGitHubEnterpriseWebhook RPC method.", +"id": "ProcessGitHubEnterpriseWebhookRequest", +"properties": { +"body": { +"$ref": "HttpBody", +"description": "Required. HTTP request body." +} +}, +"type": "object" +}, +"ProcessGitLabEnterpriseWebhookRequest": { +"description": "RPC request object accepted by the ProcessGitLabEnterpriseWebhook RPC method.", +"id": "ProcessGitLabEnterpriseWebhookRequest", +"properties": { +"body": { +"$ref": "HttpBody", +"description": "Required. HTTP request body." +} +}, +"type": "object" +}, +"ProcessGitLabWebhookRequest": { +"description": "RPC request object accepted by the ProcessGitLabWebhook RPC method.", +"id": "ProcessGitLabWebhookRequest", +"properties": { +"body": { +"$ref": "HttpBody", +"description": "Required. HTTP request body." +} +}, +"type": "object" +}, "ServiceDirectoryConfig": { "description": "ServiceDirectoryConfig represents Service Directory configuration for a connection.", "id": "ServiceDirectoryConfig", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index 1433867f80..ee5c8847ea 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -3284,7 +3284,7 @@ ], "parameters": { "conversationId": { -"description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", +"description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", "location": "query", "type": "string" }, @@ -3782,7 +3782,7 @@ ], "parameters": { "generatorId": { -"description": "Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", +"description": "Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", "location": "query", "type": "string" }, @@ -7257,7 +7257,7 @@ ], "parameters": { "conversationId": { -"description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", +"description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", "location": "query", "type": "string" }, @@ -7788,7 +7788,7 @@ ], "parameters": { "generatorId": { -"description": "Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", +"description": "Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", "location": "query", "type": "string" }, @@ -7848,7 +7848,7 @@ ], "parameters": { "name": { -"description": "Required. The generator resource name to retrieve. Format: `projects//locations/`/generators/`", +"description": "Required. The generator resource name to retrieve. Format: `projects//locations//generators/`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/generators/[^/]+$", "required": true, @@ -8714,7 +8714,7 @@ } } }, -"revision": "20240924", +"revision": "20241019", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -15765,6 +15765,11 @@ true "$ref": "GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigContextFilterSettings", "description": "Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped." }, +"contextSize": { +"description": "Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST.", +"format": "int32", +"type": "integer" +}, "dialogflowQuerySource": { "$ref": "GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySource", "description": "Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST." @@ -16246,6 +16251,13 @@ true }, "type": "array" }, +"phraseSets": { +"description": "A collection of phrase set resources to use for speech adaptation.", +"items": { +"type": "string" +}, +"type": "array" +}, "sampleRateHertz": { "description": "Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.", "format": "int32", @@ -17302,6 +17314,14 @@ true "description": "Snippet Source for a Generative Prediction.", "id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", "properties": { +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Metadata of the document.", +"type": "object" +}, "text": { "description": "Text taken from that URI.", "type": "string" @@ -18217,6 +18237,14 @@ true "description": "The sources of the answers.", "id": "GoogleCloudDialogflowV2SearchKnowledgeAnswerAnswerSource", "properties": { +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Metadata associated with the article.", +"type": "object" +}, "snippet": { "description": "The relevant snippet of the article.", "type": "string" @@ -18244,6 +18272,18 @@ true "description": "Required. The conversation profile used to configure the search. Format: `projects//locations//conversationProfiles/`.", "type": "string" }, +"endUserMetadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { \"subscription plan\": \"Business Premium Plus\", \"devices owned\": [ {\"model\": \"Google Pixel 7\"}, {\"model\": \"Google Pixel Tablet\"} ] } ```", +"type": "object" +}, +"exactSearch": { +"description": "Optional. Whether to search the query exactly without query rewrite.", +"type": "boolean" +}, "latestMessage": { "description": "Optional. The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`.", "type": "string" @@ -18256,6 +18296,24 @@ true "$ref": "GoogleCloudDialogflowV2TextInput", "description": "Required. The natural language text query for knowledge search." }, +"querySource": { +"description": "Optional. The source of the query in the request.", +"enum": [ +"QUERY_SOURCE_UNSPECIFIED", +"AGENT_QUERY", +"SUGGESTED_QUERY" +], +"enumDescriptions": [ +"Unknown query source.", +"The query is from agents.", +"The query is a suggested query from Participants.SuggestKnowledgeAssist." +], +"type": "string" +}, +"searchConfig": { +"$ref": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfig", +"description": "Optional. Configuration specific to search queries with data stores." +}, "sessionId": { "description": "Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters.", "type": "string" @@ -18263,6 +18321,160 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfig": { +"description": "Configuration specific to search queries with data stores.", +"id": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfig", +"properties": { +"boostSpecs": { +"description": "Optional. Boost specifications for data stores.", +"items": { +"$ref": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecs" +}, +"type": "array" +}, +"filterSpecs": { +"description": "Optional. Filter specification for data store queries.", +"items": { +"$ref": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigFilterSpecs" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecs": { +"description": "Boost specifications for data stores.", +"id": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecs", +"properties": { +"dataStores": { +"description": "Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}", +"items": { +"type": "string" +}, +"type": "array" +}, +"spec": { +"description": "Optional. A list of boosting specifications.", +"items": { +"$ref": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpec" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpec": { +"description": "Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec", +"id": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpec", +"properties": { +"conditionBoostSpecs": { +"description": "Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", +"items": { +"$ref": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpec" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpec": { +"description": "Boost applies to documents which match a condition.", +"id": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpec", +"properties": { +"boost": { +"description": "Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.", +"format": "float", +"type": "number" +}, +"boostControlSpec": { +"$ref": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpec", +"description": "Optional. Complex specification for custom ranking based on customer defined attribute value." +}, +"condition": { +"description": "Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": * (id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\",\"Blue\"))", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpec": { +"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", +"id": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpec", +"properties": { +"attributeType": { +"description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", +"enum": [ +"ATTRIBUTE_TYPE_UNSPECIFIED", +"NUMERICAL", +"FRESHNESS" +], +"enumDescriptions": [ +"Unspecified AttributeType.", +"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", +"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. E.g. `5D`, `3DT12H30M`, `T24H`." +], +"type": "string" +}, +"controlPoints": { +"description": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", +"items": { +"$ref": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpecControlPoint" +}, +"type": "array" +}, +"fieldName": { +"description": "Optional. The name of the field whose value will be used to determine the boost amount.", +"type": "string" +}, +"interpolationType": { +"description": "Optional. The interpolation type to be applied to connect the control points listed below.", +"enum": [ +"INTERPOLATION_TYPE_UNSPECIFIED", +"LINEAR" +], +"enumDescriptions": [ +"Interpolation type is unspecified. In this case, it defaults to Linear.", +"Piecewise linear interpolation will be applied." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { +"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", +"id": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpecControlPoint", +"properties": { +"attributeValue": { +"description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", +"type": "string" +}, +"boostAmount": { +"description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigFilterSpecs": { +"description": "Filter specification for data store queries.", +"id": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigFilterSpecs", +"properties": { +"dataStores": { +"description": "Optional. The data store where the filter configuration is applied. Full resource name of data store, such as projects/{project}/locations/{location}/collections/{collectionId}/ dataStores/{dataStoreId}.", +"items": { +"type": "string" +}, +"type": "array" +}, +"filter": { +"description": "Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2SearchKnowledgeResponse": { "description": "The response message for Conversations.SearchKnowledge.", "id": "GoogleCloudDialogflowV2SearchKnowledgeResponse", @@ -18574,6 +18786,13 @@ true "description": "Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection.", "type": "string" }, +"phraseSets": { +"description": "List of names of Cloud Speech phrase sets that are used for transcription.", +"items": { +"type": "string" +}, +"type": "array" +}, "sampleRateHertz": { "description": "Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.", "format": "int32", @@ -21141,6 +21360,14 @@ true "description": "Snippet Source for a Generative Prediction.", "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", "properties": { +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Metadata of the document.", +"type": "object" +}, "text": { "description": "Text taken from that URI.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index 56163cd7c1..32c3e209aa 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -2971,7 +2971,7 @@ ], "parameters": { "conversationId": { -"description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", +"description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", "location": "query", "type": "string" }, @@ -3571,7 +3571,7 @@ ], "parameters": { "generatorId": { -"description": "Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", +"description": "Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", "location": "query", "type": "string" }, @@ -6620,7 +6620,7 @@ ], "parameters": { "conversationId": { -"description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", +"description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", "location": "query", "type": "string" }, @@ -7180,7 +7180,7 @@ ], "parameters": { "generatorId": { -"description": "Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", +"description": "Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", "location": "query", "type": "string" }, @@ -8082,7 +8082,7 @@ } } }, -"revision": "20240924", +"revision": "20241019", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -14451,6 +14451,14 @@ true "description": "Snippet Source for a Generative Prediction.", "id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", "properties": { +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Metadata of the document.", +"type": "object" +}, "text": { "description": "Text taken from that URI.", "type": "string" @@ -17230,6 +17238,11 @@ true "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigContextFilterSettings", "description": "Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped." }, +"contextSize": { +"description": "Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST.", +"format": "int32", +"type": "integer" +}, "dialogflowQuerySource": { "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySource", "description": "Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION." @@ -17672,6 +17685,13 @@ true }, "type": "array" }, +"phraseSets": { +"description": "A collection of phrase set resources to use for speech adaptation.", +"items": { +"type": "string" +}, +"type": "array" +}, "sampleRateHertz": { "description": "Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.", "format": "int32", @@ -19072,6 +19092,14 @@ true "description": "Snippet Source for a Generative Prediction.", "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", "properties": { +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Metadata of the document.", +"type": "object" +}, "text": { "description": "Text taken from that URI.", "type": "string" @@ -20092,6 +20120,14 @@ true "description": "The sources of the answers.", "id": "GoogleCloudDialogflowV2beta1SearchKnowledgeAnswerAnswerSource", "properties": { +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Metadata associated with the article.", +"type": "object" +}, "snippet": { "description": "The relevant snippet of the article.", "type": "string" @@ -20119,6 +20155,18 @@ true "description": "Required. The conversation profile used to configure the search. Format: `projects//locations//conversationProfiles/`.", "type": "string" }, +"endUserMetadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { \"subscription plan\": \"Business Premium Plus\", \"devices owned\": [ {\"model\": \"Google Pixel 7\"}, {\"model\": \"Google Pixel Tablet\"} ] } ```", +"type": "object" +}, +"exactSearch": { +"description": "Optional. Whether to search the query exactly without query rewrite.", +"type": "boolean" +}, "latestMessage": { "description": "Optional. The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`.", "type": "string" @@ -20131,6 +20179,24 @@ true "$ref": "GoogleCloudDialogflowV2beta1TextInput", "description": "Required. The natural language text query for knowledge search." }, +"querySource": { +"description": "Optional. The source of the query in the request.", +"enum": [ +"QUERY_SOURCE_UNSPECIFIED", +"AGENT_QUERY", +"SUGGESTED_QUERY" +], +"enumDescriptions": [ +"Unknown query source.", +"The query is from agents.", +"The query is a suggested query from Participants.SuggestKnowledgeAssist." +], +"type": "string" +}, +"searchConfig": { +"$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfig", +"description": "Optional. Configuration specific to search queries with data stores." +}, "sessionId": { "description": "Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters.", "type": "string" @@ -20138,6 +20204,160 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfig": { +"description": "Configuration specific to search queries with data stores.", +"id": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfig", +"properties": { +"boostSpecs": { +"description": "Optional. Boost specifications for data stores.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecs" +}, +"type": "array" +}, +"filterSpecs": { +"description": "Optional. Filter specification for data store queries.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigFilterSpecs" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecs": { +"description": "Boost specifications for data stores.", +"id": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecs", +"properties": { +"dataStores": { +"description": "Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}", +"items": { +"type": "string" +}, +"type": "array" +}, +"spec": { +"description": "Optional. A list of boosting specifications.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpec" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpec": { +"description": "Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec", +"id": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpec", +"properties": { +"conditionBoostSpecs": { +"description": "Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpec" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpec": { +"description": "Boost applies to documents which match a condition.", +"id": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpec", +"properties": { +"boost": { +"description": "Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.", +"format": "float", +"type": "number" +}, +"boostControlSpec": { +"$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpec", +"description": "Optional. Complex specification for custom ranking based on customer defined attribute value." +}, +"condition": { +"description": "Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": * (id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\",\"Blue\"))", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpec": { +"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", +"id": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpec", +"properties": { +"attributeType": { +"description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", +"enum": [ +"ATTRIBUTE_TYPE_UNSPECIFIED", +"NUMERICAL", +"FRESHNESS" +], +"enumDescriptions": [ +"Unspecified AttributeType.", +"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", +"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. E.g. `5D`, `3DT12H30M`, `T24H`." +], +"type": "string" +}, +"controlPoints": { +"description": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpecControlPoint" +}, +"type": "array" +}, +"fieldName": { +"description": "Optional. The name of the field whose value will be used to determine the boost amount.", +"type": "string" +}, +"interpolationType": { +"description": "Optional. The interpolation type to be applied to connect the control points listed below.", +"enum": [ +"INTERPOLATION_TYPE_UNSPECIFIED", +"LINEAR" +], +"enumDescriptions": [ +"Interpolation type is unspecified. In this case, it defaults to Linear.", +"Piecewise linear interpolation will be applied." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { +"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", +"id": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpecControlPoint", +"properties": { +"attributeValue": { +"description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", +"type": "string" +}, +"boostAmount": { +"description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigFilterSpecs": { +"description": "Filter specification for data store queries.", +"id": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigFilterSpecs", +"properties": { +"dataStores": { +"description": "Optional. The data store where the filter configuration is applied. Full resource name of data store, such as projects/{project}/locations/{location}/collections/{collectionId}/ dataStores/{dataStoreId}.", +"items": { +"type": "string" +}, +"type": "array" +}, +"filter": { +"description": "Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1SearchKnowledgeResponse": { "description": "The response message for Conversations.SearchKnowledge.", "id": "GoogleCloudDialogflowV2beta1SearchKnowledgeResponse", @@ -20391,6 +20611,13 @@ true "description": "Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection.", "type": "string" }, +"phraseSets": { +"description": "List of names of Cloud Speech phrase sets that are used for transcription.", +"items": { +"type": "string" +}, +"type": "array" +}, "sampleRateHertz": { "description": "Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.", "format": "int32", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index b20456bb67..3454147bb2 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json @@ -4453,7 +4453,7 @@ } } }, -"revision": "20240924", +"revision": "20241019", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -14282,6 +14282,14 @@ true "description": "Snippet Source for a Generative Prediction.", "id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", "properties": { +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Metadata of the document.", +"type": "object" +}, "text": { "description": "Text taken from that URI.", "type": "string" @@ -16704,6 +16712,14 @@ true "description": "Snippet Source for a Generative Prediction.", "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", "properties": { +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Metadata of the document.", +"type": "object" +}, "text": { "description": "Text taken from that URI.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index 874c5980ff..10fb984ba2 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json @@ -5185,7 +5185,7 @@ } } }, -"revision": "20240924", +"revision": "20241019", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -16352,6 +16352,14 @@ true "description": "Snippet Source for a Generative Prediction.", "id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", "properties": { +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Metadata of the document.", +"type": "object" +}, "text": { "description": "Text taken from that URI.", "type": "string" @@ -18774,6 +18782,14 @@ true "description": "Snippet Source for a Generative Prediction.", "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", "properties": { +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Metadata of the document.", +"type": "object" +}, "text": { "description": "Text taken from that URI.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index 51adae6de0..25022384f0 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -271,6 +271,11 @@ "parent" ], "parameters": { +"cmekConfigName": { +"description": "Resource name of the CmekConfig to use for protecting this DataStore.", +"location": "query", +"type": "string" +}, "createAdvancedSiteSearch": { "description": "A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.", "location": "query", @@ -281,6 +286,11 @@ "location": "query", "type": "string" }, +"disableCmek": { +"description": "DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.", +"location": "query", +"type": "boolean" +}, "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.", "location": "path", @@ -3599,6 +3609,11 @@ "parent" ], "parameters": { +"cmekConfigName": { +"description": "Resource name of the CmekConfig to use for protecting this DataStore.", +"location": "query", +"type": "string" +}, "createAdvancedSiteSearch": { "description": "A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.", "location": "query", @@ -3609,6 +3624,11 @@ "location": "query", "type": "string" }, +"disableCmek": { +"description": "DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.", +"location": "query", +"type": "boolean" +}, "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.", "location": "path", @@ -5986,7 +6006,7 @@ } } }, -"revision": "20241004", +"revision": "20241020", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6135,6 +6155,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig": { +"description": "Configuration data for advance site search.", +"id": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1AlloyDbSource": { "description": "AlloyDB source import data from.", "id": "GoogleCloudDiscoveryengineV1AlloyDbSource", @@ -6182,7 +6208,8 @@ "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", "CUSTOMER_POLICY_VIOLATION", -"NON_ANSWER_SEEKING_QUERY_IGNORED_V2" +"NON_ANSWER_SEEKING_QUERY_IGNORED_V2", +"LOW_GROUNDED_ANSWER" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -6193,7 +6220,8 @@ "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", -"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent." +"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent.", +"The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated." ], "type": "string" }, @@ -7009,7 +7037,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. .", +"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.", "type": "object" }, "title": { @@ -7169,7 +7197,7 @@ "id": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", "properties": { "fhirResource": { -"description": "Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", +"description": "Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", "type": "string" }, "uri": { @@ -7372,7 +7400,7 @@ "id": "GoogleCloudDiscoveryengineV1CheckGroundingRequest", "properties": { "answerCandidate": { -"description": "Answer candidate to check. Can have a maximum length of 1024 characters.", +"description": "Answer candidate to check. It can have a maximum length of 4096 tokens.", "type": "string" }, "facts": { @@ -7403,7 +7431,7 @@ "citedChunks": { "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1FactChunk" +"$ref": "GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk" }, "type": "array" }, @@ -7455,6 +7483,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk": { +"description": "Fact chunk for grounding check.", +"id": "GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk", +"properties": { +"chunkText": { +"description": "Text content of the fact chunk. Can be at most 10K characters long.", +"type": "string" +}, +"source": { +"description": "Source from which this fact chunk was retrieved. For a fact chunk retrieved from inline facts, this field will contain the index of the specific fact from which this chunk was retrieved.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1CheckGroundingSpec": { "description": "Specification for the grounding check.", "id": "GoogleCloudDiscoveryengineV1CheckGroundingSpec", @@ -7606,6 +7649,59 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1CmekConfig": { +"description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", +"id": "GoogleCloudDiscoveryengineV1CmekConfig", +"properties": { +"isDefault": { +"description": "Output only. The default CmekConfig for the Customer.", +"readOnly": true, +"type": "boolean" +}, +"kmsKey": { +"description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", +"type": "string" +}, +"kmsKeyVersion": { +"description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", +"type": "string" +}, +"lastRotationTimestampMicros": { +"description": "Output only. The timestamp of the last key rotation.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", +"type": "string" +}, +"state": { +"description": "Output only. State of the CmekConfig.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"KEY_ISSUE", +"DELETING", +"UNUSABLE", +"ACTIVE_ROTATING" +], +"enumDescriptions": [ +"The CmekConfig state is unknown.", +"The CmekConfig is creating.", +"The CmekConfig can be used with DataStores.", +"The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", +"The CmekConfig is deleting.", +"The CmekConfig is not usable, most likely due to some internal issue.", +"The KMS key version is being rotated." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1CompleteQueryResponse": { "description": "Response message for CompletionService.CompleteQuery method.", "id": "GoogleCloudDiscoveryengineV1CompleteQueryResponse", @@ -7710,8 +7806,12 @@ }, "type": "array" }, +"queryRegex": { +"description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.", +"type": "string" +}, "queryTerms": { -"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.", "items": { "$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" }, @@ -8155,7 +8255,7 @@ "properties": { "createTime": { "deprecated": true, -"description": "Timestamp the Model was created at.", +"description": "Deprecated: Timestamp the Model was created at.", "format": "google-datetime", "type": "string" }, @@ -8220,11 +8320,20 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1DataStore", "properties": { +"advancedSiteSearchConfig": { +"$ref": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", +"description": "Optional. Configuration for advanced site search." +}, "billingEstimation": { "$ref": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", "description": "Output only. Data size estimation for billing.", "readOnly": true }, +"cmekConfig": { +"$ref": "GoogleCloudDiscoveryengineV1CmekConfig", +"description": "Output only. CMEK-related information for the DataStore.", +"readOnly": true +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -8278,12 +8387,16 @@ ], "type": "string" }, +"kmsKeyName": { +"description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.", +"type": "string" +}, "name": { "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "servingConfigDataStore": { -"$ref": "GoogleCloudDiscoveryengineV1ServingConfigDataStore", +"$ref": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore", "description": "Optional. Stores serving config at DataStore level." }, "solutionTypes": { @@ -8355,6 +8468,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore": { +"description": "Stores information regarding the serving configurations at DataStore level.", +"id": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore", +"properties": { +"disabledForServing": { +"description": "If set true, the DataStore will not be available for serving search requests.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", @@ -8903,33 +9027,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1FactChunk": { -"description": "Fact Chunk.", -"id": "GoogleCloudDiscoveryengineV1FactChunk", -"properties": { -"chunkText": { -"description": "Text content of the fact chunk. Can be at most 10K characters long.", -"type": "string" -}, -"index": { -"description": "The index of this chunk. Currently, only used for the streaming mode.", -"format": "int32", -"type": "integer" -}, -"source": { -"description": "Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved.", -"type": "string" -}, -"sourceMetadata": { -"additionalProperties": { -"type": "string" -}, -"description": "More fine-grained information for the source reference.", -"type": "object" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse": { "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.", "id": "GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse", @@ -10280,6 +10377,11 @@ "format": "int32", "type": "integer" }, +"oneBoxPageSize": { +"description": "The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.", +"format": "int32", +"type": "integer" +}, "orderBy": { "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" @@ -11131,17 +11233,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ServingConfigDataStore": { -"description": "Stores information regarding the serving configurations at DataStore level.", -"id": "GoogleCloudDiscoveryengineV1ServingConfigDataStore", -"properties": { -"disabledForServing": { -"description": "If set true, the DataStore will not be available for serving search requests.", -"type": "boolean" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1Session": { "description": "External session proto definition.", "id": "GoogleCloudDiscoveryengineV1Session", @@ -11543,6 +11634,23 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata": { +"description": "Metadata related to the progress of the CmekConfigService.UpdateCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { "description": "Metadata for UpdateSchema LRO.", "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", @@ -11750,6 +11858,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig": { +"description": "Configuration data for advance site search.", +"id": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig", +"properties": { +"disableAutomaticRefresh": { +"description": "If set true, automatic refresh is disabled for the DataStore.", +"type": "boolean" +}, +"disableInitialIndex": { +"description": "If set true, initial indexing is disabled for the DataStore.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAnswer": { "description": "Defines an answer.", "id": "GoogleCloudDiscoveryengineV1alphaAnswer", @@ -11766,7 +11889,8 @@ "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", "CUSTOMER_POLICY_VIOLATION", -"NON_ANSWER_SEEKING_QUERY_IGNORED_V2" +"NON_ANSWER_SEEKING_QUERY_IGNORED_V2", +"LOW_GROUNDED_ANSWER" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -11777,7 +11901,8 @@ "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", -"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent." +"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent.", +"The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated." ], "type": "string" }, @@ -12172,7 +12297,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. .", +"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.", "type": "object" }, "title": { @@ -12263,6 +12388,59 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaCmekConfig": { +"description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", +"id": "GoogleCloudDiscoveryengineV1alphaCmekConfig", +"properties": { +"isDefault": { +"description": "Output only. The default CmekConfig for the Customer.", +"readOnly": true, +"type": "boolean" +}, +"kmsKey": { +"description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", +"type": "string" +}, +"kmsKeyVersion": { +"description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", +"type": "string" +}, +"lastRotationTimestampMicros": { +"description": "Output only. The timestamp of the last key rotation.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", +"type": "string" +}, +"state": { +"description": "Output only. State of the CmekConfig.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"KEY_ISSUE", +"DELETING", +"UNUSABLE", +"ACTIVE_ROTATING" +], +"enumDescriptions": [ +"The CmekConfig state is unknown.", +"The CmekConfig is creating.", +"The CmekConfig can be used with DataStores.", +"The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", +"The CmekConfig is deleting.", +"The CmekConfig is not usable, most likely due to some internal issue.", +"The KMS key version is being rotated." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaCondition": { "description": "Defines circumstances to be checked before allowing a behavior", "id": "GoogleCloudDiscoveryengineV1alphaCondition", @@ -12274,8 +12452,12 @@ }, "type": "array" }, +"queryRegex": { +"description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.", +"type": "string" +}, "queryTerms": { -"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" }, @@ -12548,7 +12730,7 @@ "properties": { "createTime": { "deprecated": true, -"description": "Timestamp the Model was created at.", +"description": "Deprecated: Timestamp the Model was created at.", "format": "google-datetime", "type": "string" }, @@ -12617,11 +12799,20 @@ "description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", "type": "boolean" }, +"advancedSiteSearchConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig", +"description": "Optional. Configuration for advanced site search." +}, "billingEstimation": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation", "description": "Output only. Data size estimation for billing.", "readOnly": true }, +"cmekConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig", +"description": "Output only. CMEK-related information for the DataStore.", +"readOnly": true +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -12680,6 +12871,10 @@ ], "type": "string" }, +"kmsKeyName": { +"description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.", +"type": "string" +}, "languageInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", "description": "Language info for DataStore." @@ -12693,7 +12888,7 @@ "description": "Optional. Configuration for Natural Language Query Understanding." }, "servingConfigDataStore": { -"$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigDataStore", +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", "description": "Optional. Stores serving config at DataStore level." }, "solutionTypes": { @@ -12765,6 +12960,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore": { +"description": "Stores information regarding the serving configurations at DataStore level.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", +"properties": { +"disabledForServing": { +"description": "If set true, the DataStore will not be available for serving search requests.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", @@ -14274,12 +14480,17 @@ "type": "string" }, "invalidUris": { -"description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.", +"description": "Unique URIs in the request that have invalid format. Sample limited to 1000.", "items": { "type": "string" }, "type": "array" }, +"invalidUrisCount": { +"description": "Total number of unique URIs in the request that have invalid format.", +"format": "int32", +"type": "integer" +}, "pendingCount": { "description": "Total number of URIs that have yet to be crawled.", "format": "int32", @@ -14300,6 +14511,18 @@ "format": "google-datetime", "type": "string" }, +"urisNotMatchingTargetSites": { +"description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE. Sample limited to 1000.", +"items": { +"type": "string" +}, +"type": "array" +}, +"urisNotMatchingTargetSitesCount": { +"description": "Total number of URIs that don't match any TargetSites.", +"format": "int32", +"type": "integer" +}, "validUrisCount": { "description": "Total number of unique URIs in the request that are not in invalid_uris.", "format": "int32", @@ -14466,6 +14689,11 @@ "format": "int32", "type": "integer" }, +"oneBoxPageSize": { +"description": "The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.", +"format": "int32", +"type": "integer" +}, "orderBy": { "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" @@ -15102,17 +15330,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaServingConfigDataStore": { -"description": "Stores information regarding the serving configurations at DataStore level.", -"id": "GoogleCloudDiscoveryengineV1alphaServingConfigDataStore", -"properties": { -"disabledForServing": { -"description": "If set true, the DataStore will not be available for serving search requests.", -"type": "boolean" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1alphaSession": { "description": "External session proto definition.", "id": "GoogleCloudDiscoveryengineV1alphaSession", @@ -15395,6 +15612,23 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata": { +"description": "Metadata related to the progress of the CmekConfigService.UpdateCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { "description": "Metadata for UpdateSchema LRO.", "id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", @@ -15487,6 +15721,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig": { +"description": "Configuration data for advance site search.", +"id": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", @@ -15518,6 +15758,59 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaCmekConfig": { +"description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", +"id": "GoogleCloudDiscoveryengineV1betaCmekConfig", +"properties": { +"isDefault": { +"description": "Output only. The default CmekConfig for the Customer.", +"readOnly": true, +"type": "boolean" +}, +"kmsKey": { +"description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", +"type": "string" +}, +"kmsKeyVersion": { +"description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", +"type": "string" +}, +"lastRotationTimestampMicros": { +"description": "Output only. The timestamp of the last key rotation.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", +"type": "string" +}, +"state": { +"description": "Output only. State of the CmekConfig.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"KEY_ISSUE", +"DELETING", +"UNUSABLE", +"ACTIVE_ROTATING" +], +"enumDescriptions": [ +"The CmekConfig state is unknown.", +"The CmekConfig is creating.", +"The CmekConfig can be used with DataStores.", +"The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", +"The CmekConfig is deleting.", +"The CmekConfig is not usable, most likely due to some internal issue.", +"The KMS key version is being rotated." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaCondition": { "description": "Defines circumstances to be checked before allowing a behavior", "id": "GoogleCloudDiscoveryengineV1betaCondition", @@ -15529,8 +15822,12 @@ }, "type": "array" }, +"queryRegex": { +"description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.", +"type": "string" +}, "queryTerms": { -"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" }, @@ -15792,7 +16089,7 @@ "properties": { "createTime": { "deprecated": true, -"description": "Timestamp the Model was created at.", +"description": "Deprecated: Timestamp the Model was created at.", "format": "google-datetime", "type": "string" }, @@ -15857,11 +16154,20 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1betaDataStore", "properties": { +"advancedSiteSearchConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig", +"description": "Optional. Configuration for advanced site search." +}, "billingEstimation": { "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation", "description": "Output only. Data size estimation for billing.", "readOnly": true }, +"cmekConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig", +"description": "Output only. CMEK-related information for the DataStore.", +"readOnly": true +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -15915,6 +16221,10 @@ ], "type": "string" }, +"kmsKeyName": { +"description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.", +"type": "string" +}, "languageInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo", "description": "Language info for DataStore." @@ -15928,7 +16238,7 @@ "description": "Optional. Configuration for Natural Language Query Understanding." }, "servingConfigDataStore": { -"$ref": "GoogleCloudDiscoveryengineV1betaServingConfigDataStore", +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore", "description": "Optional. Stores serving config at DataStore level." }, "solutionTypes": { @@ -16000,6 +16310,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore": { +"description": "Stores information regarding the serving configurations at DataStore level.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore", +"properties": { +"disabledForServing": { +"description": "If set true, the DataStore will not be available for serving search requests.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", @@ -17134,6 +17455,11 @@ "format": "int32", "type": "integer" }, +"oneBoxPageSize": { +"description": "The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.", +"format": "int32", +"type": "integer" +}, "orderBy": { "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" @@ -17770,17 +18096,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaServingConfigDataStore": { -"description": "Stores information regarding the serving configurations at DataStore level.", -"id": "GoogleCloudDiscoveryengineV1betaServingConfigDataStore", -"properties": { -"disabledForServing": { -"description": "If set true, the DataStore will not be available for serving search requests.", -"type": "boolean" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1betaSiteVerificationInfo": { "description": "Verification information for target sites in advanced site search.", "id": "GoogleCloudDiscoveryengineV1betaSiteVerificationInfo", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 81dc350d0d..fbe7b9ed17 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -245,6 +245,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getCmekConfig": { +"description": "Gets the CmekConfig.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/cmekConfig", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.getCmekConfig", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "updateAclConfig": { "description": "Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/aclConfig", @@ -272,9 +297,129 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"updateCmekConfig": { +"description": "Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/cmekConfig", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.updateCmekConfig", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$", +"required": true, +"type": "string" +}, +"setDefault": { +"description": "Set the following CmekConfig as the default to be used for child resources if one is not specified.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { +"cmekConfigs": { +"methods": { +"get": { +"description": "Gets the CmekConfig.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.cmekConfigs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists all the CmekConfigs with the project.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/cmekConfigs", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.cmekConfigs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/cmekConfigs", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListCmekConfigsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.cmekConfigs.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"setDefault": { +"description": "Set the following CmekConfig as the default to be used for child resources if one is not specified.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "collections": { "resources": { "dataConnector": { @@ -407,6 +552,11 @@ "parent" ], "parameters": { +"cmekConfigName": { +"description": "Resource name of the CmekConfig to use for protecting this DataStore.", +"location": "query", +"type": "string" +}, "createAdvancedSiteSearch": { "description": "A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.", "location": "query", @@ -417,6 +567,11 @@ "location": "query", "type": "string" }, +"disableCmek": { +"description": "DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.", +"location": "query", +"type": "boolean" +}, "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.", "location": "path", @@ -4243,6 +4398,11 @@ "parent" ], "parameters": { +"cmekConfigName": { +"description": "Resource name of the CmekConfig to use for protecting this DataStore.", +"location": "query", +"type": "string" +}, "createAdvancedSiteSearch": { "description": "A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.", "location": "query", @@ -4253,6 +4413,11 @@ "location": "query", "type": "string" }, +"disableCmek": { +"description": "DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.", +"location": "query", +"type": "boolean" +}, "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.", "location": "path", @@ -7517,7 +7682,7 @@ } } }, -"revision": "20241004", +"revision": "20241020", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -7852,6 +8017,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig": { +"description": "Configuration data for advance site search.", +"id": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", @@ -7883,6 +8054,59 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1CmekConfig": { +"description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", +"id": "GoogleCloudDiscoveryengineV1CmekConfig", +"properties": { +"isDefault": { +"description": "Output only. The default CmekConfig for the Customer.", +"readOnly": true, +"type": "boolean" +}, +"kmsKey": { +"description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", +"type": "string" +}, +"kmsKeyVersion": { +"description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", +"type": "string" +}, +"lastRotationTimestampMicros": { +"description": "Output only. The timestamp of the last key rotation.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", +"type": "string" +}, +"state": { +"description": "Output only. State of the CmekConfig.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"KEY_ISSUE", +"DELETING", +"UNUSABLE", +"ACTIVE_ROTATING" +], +"enumDescriptions": [ +"The CmekConfig state is unknown.", +"The CmekConfig is creating.", +"The CmekConfig can be used with DataStores.", +"The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", +"The CmekConfig is deleting.", +"The CmekConfig is not usable, most likely due to some internal issue.", +"The KMS key version is being rotated." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1Condition": { "description": "Defines circumstances to be checked before allowing a behavior", "id": "GoogleCloudDiscoveryengineV1Condition", @@ -7894,8 +8118,12 @@ }, "type": "array" }, +"queryRegex": { +"description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.", +"type": "string" +}, "queryTerms": { -"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.", "items": { "$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" }, @@ -8149,11 +8377,20 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1DataStore", "properties": { +"advancedSiteSearchConfig": { +"$ref": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", +"description": "Optional. Configuration for advanced site search." +}, "billingEstimation": { "$ref": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", "description": "Output only. Data size estimation for billing.", "readOnly": true }, +"cmekConfig": { +"$ref": "GoogleCloudDiscoveryengineV1CmekConfig", +"description": "Output only. CMEK-related information for the DataStore.", +"readOnly": true +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -8207,12 +8444,16 @@ ], "type": "string" }, +"kmsKeyName": { +"description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.", +"type": "string" +}, "name": { "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "servingConfigDataStore": { -"$ref": "GoogleCloudDiscoveryengineV1ServingConfigDataStore", +"$ref": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore", "description": "Optional. Stores serving config at DataStore level." }, "solutionTypes": { @@ -8284,6 +8525,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore": { +"description": "Stores information regarding the serving configurations at DataStore level.", +"id": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore", +"properties": { +"disabledForServing": { +"description": "If set true, the DataStore will not be available for serving search requests.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", @@ -9112,17 +9364,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ServingConfigDataStore": { -"description": "Stores information regarding the serving configurations at DataStore level.", -"id": "GoogleCloudDiscoveryengineV1ServingConfigDataStore", -"properties": { -"disabledForServing": { -"description": "If set true, the DataStore will not be available for serving search requests.", -"type": "boolean" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1SiteVerificationInfo": { "description": "Verification information for target sites in advanced site search.", "id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", @@ -9304,6 +9545,23 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata": { +"description": "Metadata related to the progress of the CmekConfigService.UpdateCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { "description": "Metadata for UpdateSchema LRO.", "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", @@ -9396,6 +9654,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig": { +"description": "Configuration data for advance site search.", +"id": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig", +"properties": { +"disableAutomaticRefresh": { +"description": "If set true, automatic refresh is disabled for the DataStore.", +"type": "boolean" +}, +"disableInitialIndex": { +"description": "If set true, initial indexing is disabled for the DataStore.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAlloyDbSource": { "description": "AlloyDB source import data from.", "id": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", @@ -9443,7 +9716,8 @@ "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", "CUSTOMER_POLICY_VIOLATION", -"NON_ANSWER_SEEKING_QUERY_IGNORED_V2" +"NON_ANSWER_SEEKING_QUERY_IGNORED_V2", +"LOW_GROUNDED_ANSWER" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -9454,7 +9728,8 @@ "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", -"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent." +"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent.", +"The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated." ], "type": "string" }, @@ -10278,7 +10553,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. .", +"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.", "type": "object" }, "title": { @@ -10438,7 +10713,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", "properties": { "fhirResource": { -"description": "Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", +"description": "Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", "type": "string" }, "uri": { @@ -10641,7 +10916,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest", "properties": { "answerCandidate": { -"description": "Answer candidate to check. Can have a maximum length of 1024 characters.", +"description": "Answer candidate to check. It can have a maximum length of 4096 tokens.", "type": "string" }, "facts": { @@ -10672,7 +10947,7 @@ "citedChunks": { "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaFactChunk" +"$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseFactChunk" }, "type": "array" }, @@ -10724,6 +10999,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseFactChunk": { +"description": "Fact chunk for grounding check.", +"id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseFactChunk", +"properties": { +"chunkText": { +"description": "Text content of the fact chunk. Can be at most 10K characters long.", +"type": "string" +}, +"source": { +"description": "Source from which this fact chunk was retrieved. For a fact chunk retrieved from inline facts, this field will contain the index of the specific fact from which this chunk was retrieved.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec": { "description": "Specification for the grounding check.", "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec", @@ -10964,6 +11254,59 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaCmekConfig": { +"description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", +"id": "GoogleCloudDiscoveryengineV1alphaCmekConfig", +"properties": { +"isDefault": { +"description": "Output only. The default CmekConfig for the Customer.", +"readOnly": true, +"type": "boolean" +}, +"kmsKey": { +"description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", +"type": "string" +}, +"kmsKeyVersion": { +"description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", +"type": "string" +}, +"lastRotationTimestampMicros": { +"description": "Output only. The timestamp of the last key rotation.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", +"type": "string" +}, +"state": { +"description": "Output only. State of the CmekConfig.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"KEY_ISSUE", +"DELETING", +"UNUSABLE", +"ACTIVE_ROTATING" +], +"enumDescriptions": [ +"The CmekConfig state is unknown.", +"The CmekConfig is creating.", +"The CmekConfig can be used with DataStores.", +"The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", +"The CmekConfig is deleting.", +"The CmekConfig is not usable, most likely due to some internal issue.", +"The KMS key version is being rotated." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse": { "description": "Response message for CompletionService.CompleteQuery method.", "id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse", @@ -11068,8 +11411,12 @@ }, "type": "array" }, +"queryRegex": { +"description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.", +"type": "string" +}, "queryTerms": { -"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" }, @@ -11537,7 +11884,7 @@ "properties": { "createTime": { "deprecated": true, -"description": "Timestamp the Model was created at.", +"description": "Deprecated: Timestamp the Model was created at.", "format": "google-datetime", "type": "string" }, @@ -11606,11 +11953,20 @@ "description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", "type": "boolean" }, +"advancedSiteSearchConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig", +"description": "Optional. Configuration for advanced site search." +}, "billingEstimation": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation", "description": "Output only. Data size estimation for billing.", "readOnly": true }, +"cmekConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig", +"description": "Output only. CMEK-related information for the DataStore.", +"readOnly": true +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -11669,6 +12025,10 @@ ], "type": "string" }, +"kmsKeyName": { +"description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.", +"type": "string" +}, "languageInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", "description": "Language info for DataStore." @@ -11682,7 +12042,7 @@ "description": "Optional. Configuration for Natural Language Query Understanding." }, "servingConfigDataStore": { -"$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigDataStore", +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", "description": "Optional. Stores serving config at DataStore level." }, "solutionTypes": { @@ -11754,6 +12114,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore": { +"description": "Stores information regarding the serving configurations at DataStore level.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", +"properties": { +"disabledForServing": { +"description": "If set true, the DataStore will not be available for serving search requests.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", @@ -12664,33 +13035,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaFactChunk": { -"description": "Fact Chunk.", -"id": "GoogleCloudDiscoveryengineV1alphaFactChunk", -"properties": { -"chunkText": { -"description": "Text content of the fact chunk. Can be at most 10K characters long.", -"type": "string" -}, -"index": { -"description": "The index of this chunk. Currently, only used for the streaming mode.", -"format": "int32", -"type": "integer" -}, -"source": { -"description": "Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved.", -"type": "string" -}, -"sourceMetadata": { -"additionalProperties": { -"type": "string" -}, -"description": "More fine-grained information for the source reference.", -"type": "object" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse": { "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.", "id": "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse", @@ -13577,6 +13921,20 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaListCmekConfigsResponse": { +"description": "Response message for CmekConfigService.ListCmekConfigs method.", +"id": "GoogleCloudDiscoveryengineV1alphaListCmekConfigsResponse", +"properties": { +"cmekConfigs": { +"description": "All the customer's CmekConfigs.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaListControlsResponse": { "description": "Response for ListControls method.", "id": "GoogleCloudDiscoveryengineV1alphaListControlsResponse", @@ -14547,12 +14905,17 @@ "type": "string" }, "invalidUris": { -"description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.", +"description": "Unique URIs in the request that have invalid format. Sample limited to 1000.", "items": { "type": "string" }, "type": "array" }, +"invalidUrisCount": { +"description": "Total number of unique URIs in the request that have invalid format.", +"format": "int32", +"type": "integer" +}, "pendingCount": { "description": "Total number of URIs that have yet to be crawled.", "format": "int32", @@ -14573,6 +14936,18 @@ "format": "google-datetime", "type": "string" }, +"urisNotMatchingTargetSites": { +"description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE. Sample limited to 1000.", +"items": { +"type": "string" +}, +"type": "array" +}, +"urisNotMatchingTargetSitesCount": { +"description": "Total number of URIs that don't match any TargetSites.", +"format": "int32", +"type": "integer" +}, "validUrisCount": { "description": "Total number of unique URIs in the request that are not in invalid_uris.", "format": "int32", @@ -15063,6 +15438,11 @@ "format": "int32", "type": "integer" }, +"oneBoxPageSize": { +"description": "The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.", +"format": "int32", +"type": "integer" +}, "orderBy": { "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" @@ -16462,17 +16842,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaServingConfigDataStore": { -"description": "Stores information regarding the serving configurations at DataStore level.", -"id": "GoogleCloudDiscoveryengineV1alphaServingConfigDataStore", -"properties": { -"disabledForServing": { -"description": "If set true, the DataStore will not be available for serving search requests.", -"type": "boolean" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig": { "description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.", "id": "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig", @@ -16503,6 +16872,11 @@ "format": "float", "type": "number" }, +"demoteContentWatchedPastDays": { +"description": "Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days.", +"format": "int32", +"type": "integer" +}, "demotionEventType": { "description": "Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.", "type": "string" @@ -16987,6 +17361,23 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata": { +"description": "Metadata related to the progress of the CmekConfigService.UpdateCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { "description": "Metadata for UpdateSchema LRO.", "id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", @@ -17179,6 +17570,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig": { +"description": "Configuration data for advance site search.", +"id": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", @@ -17210,6 +17607,59 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaCmekConfig": { +"description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", +"id": "GoogleCloudDiscoveryengineV1betaCmekConfig", +"properties": { +"isDefault": { +"description": "Output only. The default CmekConfig for the Customer.", +"readOnly": true, +"type": "boolean" +}, +"kmsKey": { +"description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", +"type": "string" +}, +"kmsKeyVersion": { +"description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", +"type": "string" +}, +"lastRotationTimestampMicros": { +"description": "Output only. The timestamp of the last key rotation.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", +"type": "string" +}, +"state": { +"description": "Output only. State of the CmekConfig.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"KEY_ISSUE", +"DELETING", +"UNUSABLE", +"ACTIVE_ROTATING" +], +"enumDescriptions": [ +"The CmekConfig state is unknown.", +"The CmekConfig is creating.", +"The CmekConfig can be used with DataStores.", +"The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", +"The CmekConfig is deleting.", +"The CmekConfig is not usable, most likely due to some internal issue.", +"The KMS key version is being rotated." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaCondition": { "description": "Defines circumstances to be checked before allowing a behavior", "id": "GoogleCloudDiscoveryengineV1betaCondition", @@ -17221,8 +17671,12 @@ }, "type": "array" }, +"queryRegex": { +"description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.", +"type": "string" +}, "queryTerms": { -"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" }, @@ -17484,7 +17938,7 @@ "properties": { "createTime": { "deprecated": true, -"description": "Timestamp the Model was created at.", +"description": "Deprecated: Timestamp the Model was created at.", "format": "google-datetime", "type": "string" }, @@ -17549,11 +18003,20 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1betaDataStore", "properties": { +"advancedSiteSearchConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig", +"description": "Optional. Configuration for advanced site search." +}, "billingEstimation": { "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation", "description": "Output only. Data size estimation for billing.", "readOnly": true }, +"cmekConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig", +"description": "Output only. CMEK-related information for the DataStore.", +"readOnly": true +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -17607,6 +18070,10 @@ ], "type": "string" }, +"kmsKeyName": { +"description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.", +"type": "string" +}, "languageInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo", "description": "Language info for DataStore." @@ -17620,7 +18087,7 @@ "description": "Optional. Configuration for Natural Language Query Understanding." }, "servingConfigDataStore": { -"$ref": "GoogleCloudDiscoveryengineV1betaServingConfigDataStore", +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore", "description": "Optional. Stores serving config at DataStore level." }, "solutionTypes": { @@ -17692,6 +18159,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore": { +"description": "Stores information regarding the serving configurations at DataStore level.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore", +"properties": { +"disabledForServing": { +"description": "If set true, the DataStore will not be available for serving search requests.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", @@ -18826,6 +19304,11 @@ "format": "int32", "type": "integer" }, +"oneBoxPageSize": { +"description": "The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.", +"format": "int32", +"type": "integer" +}, "orderBy": { "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" @@ -19462,17 +19945,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaServingConfigDataStore": { -"description": "Stores information regarding the serving configurations at DataStore level.", -"id": "GoogleCloudDiscoveryengineV1betaServingConfigDataStore", -"properties": { -"disabledForServing": { -"description": "If set true, the DataStore will not be available for serving search requests.", -"type": "boolean" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1betaSiteVerificationInfo": { "description": "Verification information for target sites in advanced site search.", "id": "GoogleCloudDiscoveryengineV1betaSiteVerificationInfo", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index c7338b3cd1..3547769c7c 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -271,6 +271,11 @@ "parent" ], "parameters": { +"cmekConfigName": { +"description": "Resource name of the CmekConfig to use for protecting this DataStore.", +"location": "query", +"type": "string" +}, "createAdvancedSiteSearch": { "description": "A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.", "location": "query", @@ -281,6 +286,11 @@ "location": "query", "type": "string" }, +"disableCmek": { +"description": "DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.", +"location": "query", +"type": "boolean" +}, "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.", "location": "path", @@ -3873,6 +3883,11 @@ "parent" ], "parameters": { +"cmekConfigName": { +"description": "Resource name of the CmekConfig to use for protecting this DataStore.", +"location": "query", +"type": "string" +}, "createAdvancedSiteSearch": { "description": "A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.", "location": "query", @@ -3883,6 +3898,11 @@ "location": "query", "type": "string" }, +"disableCmek": { +"description": "DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.", +"location": "query", +"type": "boolean" +}, "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.", "location": "path", @@ -6860,7 +6880,7 @@ } } }, -"revision": "20241004", +"revision": "20241020", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -7009,6 +7029,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig": { +"description": "Configuration data for advance site search.", +"id": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", @@ -7040,6 +7066,59 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1CmekConfig": { +"description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", +"id": "GoogleCloudDiscoveryengineV1CmekConfig", +"properties": { +"isDefault": { +"description": "Output only. The default CmekConfig for the Customer.", +"readOnly": true, +"type": "boolean" +}, +"kmsKey": { +"description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", +"type": "string" +}, +"kmsKeyVersion": { +"description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", +"type": "string" +}, +"lastRotationTimestampMicros": { +"description": "Output only. The timestamp of the last key rotation.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", +"type": "string" +}, +"state": { +"description": "Output only. State of the CmekConfig.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"KEY_ISSUE", +"DELETING", +"UNUSABLE", +"ACTIVE_ROTATING" +], +"enumDescriptions": [ +"The CmekConfig state is unknown.", +"The CmekConfig is creating.", +"The CmekConfig can be used with DataStores.", +"The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", +"The CmekConfig is deleting.", +"The CmekConfig is not usable, most likely due to some internal issue.", +"The KMS key version is being rotated." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1Condition": { "description": "Defines circumstances to be checked before allowing a behavior", "id": "GoogleCloudDiscoveryengineV1Condition", @@ -7051,8 +7130,12 @@ }, "type": "array" }, +"queryRegex": { +"description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.", +"type": "string" +}, "queryTerms": { -"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.", "items": { "$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" }, @@ -7306,11 +7389,20 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1DataStore", "properties": { +"advancedSiteSearchConfig": { +"$ref": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", +"description": "Optional. Configuration for advanced site search." +}, "billingEstimation": { "$ref": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", "description": "Output only. Data size estimation for billing.", "readOnly": true }, +"cmekConfig": { +"$ref": "GoogleCloudDiscoveryengineV1CmekConfig", +"description": "Output only. CMEK-related information for the DataStore.", +"readOnly": true +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -7364,12 +7456,16 @@ ], "type": "string" }, +"kmsKeyName": { +"description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.", +"type": "string" +}, "name": { "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "servingConfigDataStore": { -"$ref": "GoogleCloudDiscoveryengineV1ServingConfigDataStore", +"$ref": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore", "description": "Optional. Stores serving config at DataStore level." }, "solutionTypes": { @@ -7441,6 +7537,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore": { +"description": "Stores information regarding the serving configurations at DataStore level.", +"id": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore", +"properties": { +"disabledForServing": { +"description": "If set true, the DataStore will not be available for serving search requests.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", @@ -8269,17 +8376,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ServingConfigDataStore": { -"description": "Stores information regarding the serving configurations at DataStore level.", -"id": "GoogleCloudDiscoveryengineV1ServingConfigDataStore", -"properties": { -"disabledForServing": { -"description": "If set true, the DataStore will not be available for serving search requests.", -"type": "boolean" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1SiteVerificationInfo": { "description": "Verification information for target sites in advanced site search.", "id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", @@ -8461,6 +8557,23 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata": { +"description": "Metadata related to the progress of the CmekConfigService.UpdateCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { "description": "Metadata for UpdateSchema LRO.", "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", @@ -8553,6 +8666,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig": { +"description": "Configuration data for advance site search.", +"id": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig", +"properties": { +"disableAutomaticRefresh": { +"description": "If set true, automatic refresh is disabled for the DataStore.", +"type": "boolean" +}, +"disableInitialIndex": { +"description": "If set true, initial indexing is disabled for the DataStore.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAnswer": { "description": "Defines an answer.", "id": "GoogleCloudDiscoveryengineV1alphaAnswer", @@ -8569,7 +8697,8 @@ "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", "CUSTOMER_POLICY_VIOLATION", -"NON_ANSWER_SEEKING_QUERY_IGNORED_V2" +"NON_ANSWER_SEEKING_QUERY_IGNORED_V2", +"LOW_GROUNDED_ANSWER" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -8580,7 +8709,8 @@ "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", -"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent." +"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent.", +"The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated." ], "type": "string" }, @@ -8975,7 +9105,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. .", +"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.", "type": "object" }, "title": { @@ -9066,6 +9196,59 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaCmekConfig": { +"description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", +"id": "GoogleCloudDiscoveryengineV1alphaCmekConfig", +"properties": { +"isDefault": { +"description": "Output only. The default CmekConfig for the Customer.", +"readOnly": true, +"type": "boolean" +}, +"kmsKey": { +"description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", +"type": "string" +}, +"kmsKeyVersion": { +"description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", +"type": "string" +}, +"lastRotationTimestampMicros": { +"description": "Output only. The timestamp of the last key rotation.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", +"type": "string" +}, +"state": { +"description": "Output only. State of the CmekConfig.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"KEY_ISSUE", +"DELETING", +"UNUSABLE", +"ACTIVE_ROTATING" +], +"enumDescriptions": [ +"The CmekConfig state is unknown.", +"The CmekConfig is creating.", +"The CmekConfig can be used with DataStores.", +"The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", +"The CmekConfig is deleting.", +"The CmekConfig is not usable, most likely due to some internal issue.", +"The KMS key version is being rotated." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaCondition": { "description": "Defines circumstances to be checked before allowing a behavior", "id": "GoogleCloudDiscoveryengineV1alphaCondition", @@ -9077,8 +9260,12 @@ }, "type": "array" }, +"queryRegex": { +"description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.", +"type": "string" +}, "queryTerms": { -"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" }, @@ -9351,7 +9538,7 @@ "properties": { "createTime": { "deprecated": true, -"description": "Timestamp the Model was created at.", +"description": "Deprecated: Timestamp the Model was created at.", "format": "google-datetime", "type": "string" }, @@ -9420,11 +9607,20 @@ "description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", "type": "boolean" }, +"advancedSiteSearchConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig", +"description": "Optional. Configuration for advanced site search." +}, "billingEstimation": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation", "description": "Output only. Data size estimation for billing.", "readOnly": true }, +"cmekConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig", +"description": "Output only. CMEK-related information for the DataStore.", +"readOnly": true +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -9483,6 +9679,10 @@ ], "type": "string" }, +"kmsKeyName": { +"description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.", +"type": "string" +}, "languageInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", "description": "Language info for DataStore." @@ -9496,7 +9696,7 @@ "description": "Optional. Configuration for Natural Language Query Understanding." }, "servingConfigDataStore": { -"$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigDataStore", +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", "description": "Optional. Stores serving config at DataStore level." }, "solutionTypes": { @@ -9568,6 +9768,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore": { +"description": "Stores information regarding the serving configurations at DataStore level.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", +"properties": { +"disabledForServing": { +"description": "If set true, the DataStore will not be available for serving search requests.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", @@ -11077,12 +11288,17 @@ "type": "string" }, "invalidUris": { -"description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.", +"description": "Unique URIs in the request that have invalid format. Sample limited to 1000.", "items": { "type": "string" }, "type": "array" }, +"invalidUrisCount": { +"description": "Total number of unique URIs in the request that have invalid format.", +"format": "int32", +"type": "integer" +}, "pendingCount": { "description": "Total number of URIs that have yet to be crawled.", "format": "int32", @@ -11103,6 +11319,18 @@ "format": "google-datetime", "type": "string" }, +"urisNotMatchingTargetSites": { +"description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE. Sample limited to 1000.", +"items": { +"type": "string" +}, +"type": "array" +}, +"urisNotMatchingTargetSitesCount": { +"description": "Total number of URIs that don't match any TargetSites.", +"format": "int32", +"type": "integer" +}, "validUrisCount": { "description": "Total number of unique URIs in the request that are not in invalid_uris.", "format": "int32", @@ -11269,6 +11497,11 @@ "format": "int32", "type": "integer" }, +"oneBoxPageSize": { +"description": "The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.", +"format": "int32", +"type": "integer" +}, "orderBy": { "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" @@ -11905,17 +12138,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaServingConfigDataStore": { -"description": "Stores information regarding the serving configurations at DataStore level.", -"id": "GoogleCloudDiscoveryengineV1alphaServingConfigDataStore", -"properties": { -"disabledForServing": { -"description": "If set true, the DataStore will not be available for serving search requests.", -"type": "boolean" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1alphaSession": { "description": "External session proto definition.", "id": "GoogleCloudDiscoveryengineV1alphaSession", @@ -12198,6 +12420,23 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata": { +"description": "Metadata related to the progress of the CmekConfigService.UpdateCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { "description": "Metadata for UpdateSchema LRO.", "id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", @@ -12290,6 +12529,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig": { +"description": "Configuration data for advance site search.", +"id": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaAlloyDbSource": { "description": "AlloyDB source import data from.", "id": "GoogleCloudDiscoveryengineV1betaAlloyDbSource", @@ -12337,7 +12582,8 @@ "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", "CUSTOMER_POLICY_VIOLATION", -"NON_ANSWER_SEEKING_QUERY_IGNORED_V2" +"NON_ANSWER_SEEKING_QUERY_IGNORED_V2", +"LOW_GROUNDED_ANSWER" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -12348,7 +12594,8 @@ "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", -"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent." +"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent.", +"The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated." ], "type": "string" }, @@ -13168,7 +13415,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. .", +"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.", "type": "object" }, "title": { @@ -13328,7 +13575,7 @@ "id": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", "properties": { "fhirResource": { -"description": "Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", +"description": "Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", "type": "string" }, "uri": { @@ -13531,7 +13778,7 @@ "id": "GoogleCloudDiscoveryengineV1betaCheckGroundingRequest", "properties": { "answerCandidate": { -"description": "Answer candidate to check. Can have a maximum length of 1024 characters.", +"description": "Answer candidate to check. It can have a maximum length of 4096 tokens.", "type": "string" }, "facts": { @@ -13562,7 +13809,7 @@ "citedChunks": { "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1betaFactChunk" +"$ref": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk" }, "type": "array" }, @@ -13614,6 +13861,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk": { +"description": "Fact chunk for grounding check.", +"id": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk", +"properties": { +"chunkText": { +"description": "Text content of the fact chunk. Can be at most 10K characters long.", +"type": "string" +}, +"source": { +"description": "Source from which this fact chunk was retrieved. For a fact chunk retrieved from inline facts, this field will contain the index of the specific fact from which this chunk was retrieved.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaCheckGroundingSpec": { "description": "Specification for the grounding check.", "id": "GoogleCloudDiscoveryengineV1betaCheckGroundingSpec", @@ -13765,6 +14027,59 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaCmekConfig": { +"description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", +"id": "GoogleCloudDiscoveryengineV1betaCmekConfig", +"properties": { +"isDefault": { +"description": "Output only. The default CmekConfig for the Customer.", +"readOnly": true, +"type": "boolean" +}, +"kmsKey": { +"description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", +"type": "string" +}, +"kmsKeyVersion": { +"description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", +"type": "string" +}, +"lastRotationTimestampMicros": { +"description": "Output only. The timestamp of the last key rotation.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", +"type": "string" +}, +"state": { +"description": "Output only. State of the CmekConfig.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"KEY_ISSUE", +"DELETING", +"UNUSABLE", +"ACTIVE_ROTATING" +], +"enumDescriptions": [ +"The CmekConfig state is unknown.", +"The CmekConfig is creating.", +"The CmekConfig can be used with DataStores.", +"The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", +"The CmekConfig is deleting.", +"The CmekConfig is not usable, most likely due to some internal issue.", +"The KMS key version is being rotated." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaCompleteQueryResponse": { "description": "Response message for CompletionService.CompleteQuery method.", "id": "GoogleCloudDiscoveryengineV1betaCompleteQueryResponse", @@ -13869,8 +14184,12 @@ }, "type": "array" }, +"queryRegex": { +"description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.", +"type": "string" +}, "queryTerms": { -"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" }, @@ -14327,7 +14646,7 @@ "properties": { "createTime": { "deprecated": true, -"description": "Timestamp the Model was created at.", +"description": "Deprecated: Timestamp the Model was created at.", "format": "google-datetime", "type": "string" }, @@ -14392,11 +14711,20 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1betaDataStore", "properties": { +"advancedSiteSearchConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig", +"description": "Optional. Configuration for advanced site search." +}, "billingEstimation": { "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation", "description": "Output only. Data size estimation for billing.", "readOnly": true }, +"cmekConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig", +"description": "Output only. CMEK-related information for the DataStore.", +"readOnly": true +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -14450,6 +14778,10 @@ ], "type": "string" }, +"kmsKeyName": { +"description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.", +"type": "string" +}, "languageInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo", "description": "Language info for DataStore." @@ -14463,7 +14795,7 @@ "description": "Optional. Configuration for Natural Language Query Understanding." }, "servingConfigDataStore": { -"$ref": "GoogleCloudDiscoveryengineV1betaServingConfigDataStore", +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore", "description": "Optional. Stores serving config at DataStore level." }, "solutionTypes": { @@ -14535,6 +14867,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore": { +"description": "Stores information regarding the serving configurations at DataStore level.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore", +"properties": { +"disabledForServing": { +"description": "If set true, the DataStore will not be available for serving search requests.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", @@ -15199,33 +15542,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaFactChunk": { -"description": "Fact Chunk.", -"id": "GoogleCloudDiscoveryengineV1betaFactChunk", -"properties": { -"chunkText": { -"description": "Text content of the fact chunk. Can be at most 10K characters long.", -"type": "string" -}, -"index": { -"description": "The index of this chunk. Currently, only used for the streaming mode.", -"format": "int32", -"type": "integer" -}, -"source": { -"description": "Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved.", -"type": "string" -}, -"sourceMetadata": { -"additionalProperties": { -"type": "string" -}, -"description": "More fine-grained information for the source reference.", -"type": "object" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse": { "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.", "id": "GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse", @@ -16983,6 +17299,11 @@ "format": "int32", "type": "integer" }, +"oneBoxPageSize": { +"description": "The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.", +"format": "int32", +"type": "integer" +}, "orderBy": { "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" @@ -18374,17 +18695,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaServingConfigDataStore": { -"description": "Stores information regarding the serving configurations at DataStore level.", -"id": "GoogleCloudDiscoveryengineV1betaServingConfigDataStore", -"properties": { -"disabledForServing": { -"description": "If set true, the DataStore will not be available for serving search requests.", -"type": "boolean" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig": { "description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.", "id": "GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig", @@ -18415,6 +18725,11 @@ "format": "float", "type": "number" }, +"demoteContentWatchedPastDays": { +"description": "Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days.", +"format": "int32", +"type": "integer" +}, "demotionEventType": { "description": "Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json index 62b3f59aff..9d8d28e3ce 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v2.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json @@ -9267,7 +9267,7 @@ } } }, -"revision": "20241003", +"revision": "20241024", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -9421,11 +9421,11 @@ "type": "object" }, "Adloox": { -"description": "Details of Adloox settings.", +"description": "Details of Adloox brand safety settings.", "id": "Adloox", "properties": { "excludedAdlooxCategories": { -"description": "Adloox's brand safety settings.", +"description": "Adloox categories to exclude.", "items": { "enum": [ "ADLOOX_UNSPECIFIED", @@ -9439,7 +9439,7 @@ "FRAUD" ], "enumDescriptions": [ -"This enum is only a placeholder and it doesn't specify any Adloox option.", +"Default value when a Adloox category is not specified or is unknown in this version.", "Adult content (hard).", "Adult content (soft).", "Illegal content.", @@ -9472,7 +9472,7 @@ }, "billingConfig": { "$ref": "AdvertiserBillingConfig", -"description": "Optional. Required. Billing related settings of the advertiser." +"description": "Required. Billing related settings of the advertiser." }, "creativeConfig": { "$ref": "AdvertiserCreativeConfig", @@ -9561,7 +9561,7 @@ "id": "AdvertiserBillingConfig", "properties": { "billingProfileId": { -"description": "Optional. The ID of a billing profile assigned to the advertiser.", +"description": "Required. The ID of a billing profile assigned to the advertiser.", "format": "int64", "type": "string" } @@ -12332,7 +12332,8 @@ "SDF_VERSION_5_5", "SDF_VERSION_6", "SDF_VERSION_7", -"SDF_VERSION_7_1" +"SDF_VERSION_7_1", +"SDF_VERSION_8" ], "enumDeprecated": [ false, @@ -12348,6 +12349,7 @@ true, true, false, false, +false, false ], "enumDescriptions": [ @@ -12364,7 +12366,8 @@ false "SDF version 5.5", "SDF version 6", "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", -"SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version." +"SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", +"SDF version 8. **This SDF version is in beta. It is only available to a subset of users.**" ], "type": "string" } @@ -19849,7 +19852,8 @@ false "SDF_VERSION_5_5", "SDF_VERSION_6", "SDF_VERSION_7", -"SDF_VERSION_7_1" +"SDF_VERSION_7_1", +"SDF_VERSION_8" ], "enumDeprecated": [ false, @@ -19865,6 +19869,7 @@ true, true, false, false, +false, false ], "enumDescriptions": [ @@ -19881,7 +19886,8 @@ false "SDF version 5.5", "SDF version 6", "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", -"SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version." +"SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", +"SDF version 8. **This SDF version is in beta. It is only available to a subset of users.**" ], "type": "string" } @@ -19929,7 +19935,8 @@ false "SDF_VERSION_5_5", "SDF_VERSION_6", "SDF_VERSION_7", -"SDF_VERSION_7_1" +"SDF_VERSION_7_1", +"SDF_VERSION_8" ], "enumDeprecated": [ false, @@ -19945,6 +19952,7 @@ true, true, false, false, +false, false ], "enumDescriptions": [ @@ -19961,7 +19969,8 @@ false "SDF version 5.5", "SDF version 6", "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", -"SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version." +"SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", +"SDF version 8. **This SDF version is in beta. It is only available to a subset of users.**" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v3.json b/googleapiclient/discovery_cache/documents/displayvideo.v3.json index aa7ddbfb06..8643a74aa1 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v3.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v3.json @@ -9222,7 +9222,7 @@ } } }, -"revision": "20241003", +"revision": "20241024", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -9563,11 +9563,121 @@ "type": "object" }, "Adloox": { -"description": "Details of Adloox settings.", +"description": "Details of Adloox brand safety settings.", "id": "Adloox", "properties": { +"adultExplicitSexualContent": { +"description": "Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"armsAmmunitionContent": { +"description": "Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": { +"description": "Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"deathInjuryMilitaryConflictContent": { +"description": "Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"debatedSensitiveSocialIssueContent": { +"description": "Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"displayIabViewability": { +"description": "Optional. IAB viewability threshold for display ads.", +"enum": [ +"DISPLAY_IAB_VIEWABILITY_UNSPECIFIED", +"DISPLAY_IAB_VIEWABILITY_10", +"DISPLAY_IAB_VIEWABILITY_20", +"DISPLAY_IAB_VIEWABILITY_35", +"DISPLAY_IAB_VIEWABILITY_50", +"DISPLAY_IAB_VIEWABILITY_75" +], +"enumDescriptions": [ +"Default value when not specified or is unknown in this version.", +"10%+ in view (IAB display viewability standard).", +"20%+ in view (IAB display viewability standard).", +"35%+ in view (IAB display viewability standard).", +"50%+ in view (IAB display viewability standard).", +"75%+ in view (IAB display viewability standard)." +], +"type": "string" +}, "excludedAdlooxCategories": { -"description": "Adloox's brand safety settings.", +"description": "Adloox categories to exclude.", "items": { "enum": [ "ADLOOX_UNSPECIFIED", @@ -9581,7 +9691,7 @@ "FRAUD" ], "enumDescriptions": [ -"This enum is only a placeholder and it doesn't specify any Adloox option.", +"Default value when a Adloox category is not specified or is unknown in this version.", "Adult content (hard).", "Adult content (soft).", "Illegal content.", @@ -9594,6 +9704,167 @@ "type": "string" }, "type": "array" +}, +"excludedFraudIvtMfaCategories": { +"description": "Optional. Adloox's fraud IVT MFA categories to exclude.", +"items": { +"enum": [ +"FRAUD_IVT_MFA_CATEGORY_UNSPECIFIED", +"FRAUD_IVT_MFA" +], +"enumDescriptions": [ +"Default value when a Adloox Fraud, IVT, MFA category is not specified or is unknown in this version.", +"FRAUD, IVT, MFA." +], +"type": "string" +}, +"type": "array" +}, +"hateSpeechActsAggressionContent": { +"description": "Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"illegalDrugsTobaccoEcigarettesVapingAlcoholContent": { +"description": "Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"misinformationContent": { +"description": "Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"obscenityProfanityContent": { +"description": "Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"onlinePiracyContent": { +"description": "Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"spamHarmfulContent": { +"description": "Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"terrorismContent": { +"description": "Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", +"enum": [ +"GARM_RISK_EXCLUSION_UNSPECIFIED", +"GARM_RISK_EXCLUSION_FLOOR", +"GARM_RISK_EXCLUSION_HIGH", +"GARM_RISK_EXCLUSION_MEDIUM", +"GARM_RISK_EXCLUSION_LOW" +], +"enumDescriptions": [ +"This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", +"Exclude floor risk.", +"Exclude high and floor risk.", +"Exclude medium, high, and floor risk.", +"Exclude all levels of risk (low, medium, high and floor)." +], +"type": "string" +}, +"videoIabViewability": { +"description": "Optional. IAB viewability threshold for video ads.", +"enum": [ +"VIDEO_IAB_VIEWABILITY_UNSPECIFIED", +"VIDEO_IAB_VIEWABILITY_10", +"VIDEO_IAB_VIEWABILITY_20", +"VIDEO_IAB_VIEWABILITY_35", +"VIDEO_IAB_VIEWABILITY_50", +"VIDEO_IAB_VIEWABILITY_75" +], +"enumDescriptions": [ +"Default value when not specified or is unknown in this version.", +"10%+ in view (IAB video viewability standard).", +"20%+ in view (IAB video viewability standard).", +"35%+ in view (IAB video viewability standard).", +"50%+ in view (IAB video viewability standard).", +"75%+ in view (IAB video viewability standard)." +], +"type": "string" } }, "type": "object" @@ -9614,7 +9885,7 @@ }, "billingConfig": { "$ref": "AdvertiserBillingConfig", -"description": "Optional. Required. Billing related settings of the advertiser." +"description": "Required. Billing related settings of the advertiser." }, "creativeConfig": { "$ref": "AdvertiserCreativeConfig", @@ -9703,7 +9974,7 @@ "id": "AdvertiserBillingConfig", "properties": { "billingProfileId": { -"description": "Optional. The ID of a billing profile assigned to the advertiser.", +"description": "Required. The ID of a billing profile assigned to the advertiser.", "format": "int64", "type": "string" } @@ -12907,7 +13178,8 @@ "SDF_VERSION_5_5", "SDF_VERSION_6", "SDF_VERSION_7", -"SDF_VERSION_7_1" +"SDF_VERSION_7_1", +"SDF_VERSION_8" ], "enumDeprecated": [ false, @@ -12923,6 +13195,7 @@ true, true, false, false, +false, false ], "enumDescriptions": [ @@ -12939,7 +13212,8 @@ false "SDF version 5.5", "SDF version 6", "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", -"SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version." +"SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", +"SDF version 8. **This SDF version is in beta. It is only available to a subset of users.**" ], "type": "string" } @@ -20620,7 +20894,8 @@ false "SDF_VERSION_5_5", "SDF_VERSION_6", "SDF_VERSION_7", -"SDF_VERSION_7_1" +"SDF_VERSION_7_1", +"SDF_VERSION_8" ], "enumDeprecated": [ false, @@ -20636,6 +20911,7 @@ true, true, false, false, +false, false ], "enumDescriptions": [ @@ -20652,7 +20928,8 @@ false "SDF version 5.5", "SDF version 6", "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", -"SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version." +"SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", +"SDF version 8. **This SDF version is in beta. It is only available to a subset of users.**" ], "type": "string" } @@ -20700,7 +20977,8 @@ false "SDF_VERSION_5_5", "SDF_VERSION_6", "SDF_VERSION_7", -"SDF_VERSION_7_1" +"SDF_VERSION_7_1", +"SDF_VERSION_8" ], "enumDeprecated": [ false, @@ -20716,6 +20994,7 @@ true, true, false, false, +false, false ], "enumDescriptions": [ @@ -20732,7 +21011,8 @@ false "SDF version 5.5", "SDF version 6", "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", -"SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version." +"SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", +"SDF version 8. **This SDF version is in beta. It is only available to a subset of users.**" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index 9cc33c564f..6bea2d9f22 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -5015,7 +5015,7 @@ } } }, -"revision": "20241006", +"revision": "20241020", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -5431,7 +5431,7 @@ "type": "string" }, "projectId": { -"description": "The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.", +"description": "The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.", "type": "string" }, "tableId": { @@ -5462,12 +5462,14 @@ "enum": [ "BIG_QUERY_TABLE_TYPE_UNSPECIFIED", "BIG_QUERY_TABLE_TYPE_TABLE", -"BIG_QUERY_TABLE_TYPE_EXTERNAL_BIG_LAKE" +"BIG_QUERY_TABLE_TYPE_EXTERNAL_BIG_LAKE", +"BIG_QUERY_TABLE_TYPE_SNAPSHOT" ], "enumDescriptions": [ "Unused.", "A normal BigQuery table.", -"A table that references data stored in Cloud Storage." +"A table that references data stored in Cloud Storage.", +"A snapshot of a BigQuery table." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json index 1503e3eadb..63ec94a1b8 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json @@ -1284,7 +1284,7 @@ } } }, -"revision": "20240911", +"revision": "20241025", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -3004,6 +3004,16 @@ "name": { "description": "Dataset schema resource name. Format: `projects/{project}/locations/{location}/processors/{processor}/dataset/datasetSchema`", "type": "string" +}, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index 65ab2ecdd9..2d0867495b 100644 --- a/googleapiclient/discovery_cache/documents/drive.v3.json +++ b/googleapiclient/discovery_cache/documents/drive.v3.json @@ -1783,7 +1783,7 @@ "type": "string" }, "role": { -"description": "Optional. The roles the approver has allowed, if any.", +"description": "Optional. The roles the approver has allowed, if any. Note: This field is required for the `ACCEPT` action.", "location": "query", "repeated": true, "type": "string" @@ -2769,7 +2769,7 @@ } } }, -"revision": "20241008", +"revision": "20241014", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/googleapiclient/discovery_cache/documents/eventarc.v1.json b/googleapiclient/discovery_cache/documents/eventarc.v1.json index 55f6c779c8..41c2cf9dfd 100644 --- a/googleapiclient/discovery_cache/documents/eventarc.v1.json +++ b/googleapiclient/discovery_cache/documents/eventarc.v1.json @@ -712,102 +712,114 @@ }, "enrollments": { "methods": { -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/enrollments/{enrollmentsId}:getIamPolicy", -"httpMethod": "GET", -"id": "eventarc.projects.locations.enrollments.getIamPolicy", +"create": { +"description": "Create a new Enrollment in a particular project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/enrollments", +"httpMethod": "POST", +"id": "eventarc.projects.locations.enrollments.create", "parameterOrder": [ -"resource" +"parent" ], "parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", +"enrollmentId": { +"description": "Required. The user-provided ID to be assigned to the Enrollment. It should match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).", "location": "query", -"type": "integer" +"type": "string" }, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"parent": { +"description": "Required. The parent collection in which to add this enrollment.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/enrollments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" +}, +"validateOnly": { +"description": "Optional. If set, validate the request and preview the review, but do not post it.", +"location": "query", +"type": "boolean" } }, -"path": "v1/{+resource}:getIamPolicy", +"path": "v1/{+parent}/enrollments", +"request": { +"$ref": "Enrollment" +}, "response": { -"$ref": "Policy" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"setIamPolicy": { -"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/enrollments/{enrollmentsId}:setIamPolicy", -"httpMethod": "POST", -"id": "eventarc.projects.locations.enrollments.setIamPolicy", +"delete": { +"description": "Delete a single Enrollment.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/enrollments/{enrollmentsId}", +"httpMethod": "DELETE", +"id": "eventarc.projects.locations.enrollments.delete", "parameterOrder": [ -"resource" +"name" ], "parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"allowMissing": { +"description": "Optional. If set to true, and the Enrollment is not found, the request will succeed but no action will be taken on the server.", +"location": "query", +"type": "boolean" +}, +"etag": { +"description": "Optional. If provided, the Enrollment will only be deleted if the etag matches the current etag on the resource.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the Enrollment to be deleted.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/enrollments/[^/]+$", "required": true, "type": "string" -} }, -"path": "v1/{+resource}:setIamPolicy", -"request": { -"$ref": "SetIamPolicyRequest" +"validateOnly": { +"description": "Optional. If set, validate the request and preview the review, but do not post it.", +"location": "query", +"type": "boolean" +} }, +"path": "v1/{+name}", "response": { -"$ref": "Policy" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/enrollments/{enrollmentsId}:testIamPermissions", -"httpMethod": "POST", -"id": "eventarc.projects.locations.enrollments.testIamPermissions", +"get": { +"description": "Get a single Enrollment.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/enrollments/{enrollmentsId}", +"httpMethod": "GET", +"id": "eventarc.projects.locations.enrollments.get", "parameterOrder": [ -"resource" +"name" ], "parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"name": { +"description": "Required. The name of the Enrollment to get.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/enrollments/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+resource}:testIamPermissions", -"request": { -"$ref": "TestIamPermissionsRequest" -}, +"path": "v1/{+name}", "response": { -"$ref": "TestIamPermissionsResponse" +"$ref": "Enrollment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} }, -"googleApiSources": { -"methods": { "getIamPolicy": { "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/googleApiSources/{googleApiSourcesId}:getIamPolicy", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/enrollments/{enrollmentsId}:getIamPolicy", "httpMethod": "GET", -"id": "eventarc.projects.locations.googleApiSources.getIamPolicy", +"id": "eventarc.projects.locations.enrollments.getIamPolicy", "parameterOrder": [ "resource" ], @@ -821,7 +833,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/googleApiSources/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/enrollments/[^/]+$", "required": true, "type": "string" } @@ -834,92 +846,91 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"setIamPolicy": { -"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/googleApiSources/{googleApiSourcesId}:setIamPolicy", -"httpMethod": "POST", -"id": "eventarc.projects.locations.googleApiSources.setIamPolicy", +"list": { +"description": "List Enrollments.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/enrollments", +"httpMethod": "GET", +"id": "eventarc.projects.locations.enrollments.list", "parameterOrder": [ -"resource" +"parent" ], "parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/googleApiSources/[^/]+$", -"required": true, +"filter": { +"description": "Optional. The filter field that the list request will filter on. Possible filtersare described in https://google.aip.dev/160.", +"location": "query", "type": "string" -} }, -"path": "v1/{+resource}:setIamPolicy", -"request": { -"$ref": "SetIamPolicyRequest" +"orderBy": { +"description": "Optional. The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a `desc` suffix; for example: `name desc, update_time`.", +"location": "query", +"type": "string" }, -"response": { -"$ref": "Policy" +"pageSize": { +"description": "Optional. The maximum number of results to return on each page. Note: The service may send fewer.", +"format": "int32", +"location": "query", +"type": "integer" }, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] +"pageToken": { +"description": "Optional. The page token; provide the value from the `next_page_token` field in a previous call to retrieve the subsequent page. When paginating, all other parameters provided must match the previous call that provided the page token.", +"location": "query", +"type": "string" }, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/googleApiSources/{googleApiSourcesId}:testIamPermissions", -"httpMethod": "POST", -"id": "eventarc.projects.locations.googleApiSources.testIamPermissions", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"parent": { +"description": "Required. The parent collection to list triggers on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/googleApiSources/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+resource}:testIamPermissions", -"request": { -"$ref": "TestIamPermissionsRequest" -}, +"path": "v1/{+parent}/enrollments", "response": { -"$ref": "TestIamPermissionsResponse" +"$ref": "ListEnrollmentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} }, -"messageBuses": { -"methods": { -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/messageBuses/{messageBusesId}:getIamPolicy", -"httpMethod": "GET", -"id": "eventarc.projects.locations.messageBuses.getIamPolicy", +"patch": { +"description": "Update a single Enrollment.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/enrollments/{enrollmentsId}", +"httpMethod": "PATCH", +"id": "eventarc.projects.locations.enrollments.patch", "parameterOrder": [ -"resource" +"name" ], "parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", +"allowMissing": { +"description": "Optional. If set to true, and the Enrollment is not found, a new Enrollment will be created. In this situation, `update_mask` is ignored.", "location": "query", -"type": "integer" +"type": "boolean" }, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"name": { +"description": "Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/messageBuses/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/enrollments/[^/]+$", "required": true, "type": "string" +}, +"updateMask": { +"description": "Optional. The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of \"*\".", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, validate the request and preview the review, but do not post it.", +"location": "query", +"type": "boolean" } }, -"path": "v1/{+resource}:getIamPolicy", +"path": "v1/{+name}", +"request": { +"$ref": "Enrollment" +}, "response": { -"$ref": "Policy" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -927,9 +938,9 @@ }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/messageBuses/{messageBusesId}:setIamPolicy", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/enrollments/{enrollmentsId}:setIamPolicy", "httpMethod": "POST", -"id": "eventarc.projects.locations.messageBuses.setIamPolicy", +"id": "eventarc.projects.locations.enrollments.setIamPolicy", "parameterOrder": [ "resource" ], @@ -937,7 +948,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/messageBuses/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/enrollments/[^/]+$", "required": true, "type": "string" } @@ -955,9 +966,9 @@ }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/messageBuses/{messageBusesId}:testIamPermissions", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/enrollments/{enrollmentsId}:testIamPermissions", "httpMethod": "POST", -"id": "eventarc.projects.locations.messageBuses.testIamPermissions", +"id": "eventarc.projects.locations.enrollments.testIamPermissions", "parameterOrder": [ "resource" ], @@ -965,7 +976,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/messageBuses/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/enrollments/[^/]+$", "required": true, "type": "string" } @@ -983,89 +994,693 @@ } } }, -"operations": { +"googleApiSources": { "methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", +"create": { +"description": "Create a new GoogleApiSource in a particular project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/googleApiSources", "httpMethod": "POST", -"id": "eventarc.projects.locations.operations.cancel", +"id": "eventarc.projects.locations.googleApiSources.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", +"googleApiSourceId": { +"description": "Required. The user-provided ID to be assigned to the GoogleApiSource. It should match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent collection in which to add this google api source.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" +}, +"validateOnly": { +"description": "Optional. If set, validate the request and preview the review, but do not post it.", +"location": "query", +"type": "boolean" } }, -"path": "v1/{+name}:cancel", +"path": "v1/{+parent}/googleApiSources", "request": { -"$ref": "GoogleLongrunningCancelOperationRequest" +"$ref": "GoogleApiSource" }, "response": { -"$ref": "Empty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"description": "Delete a single GoogleApiSource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/googleApiSources/{googleApiSourcesId}", "httpMethod": "DELETE", -"id": "eventarc.projects.locations.operations.delete", +"id": "eventarc.projects.locations.googleApiSources.delete", "parameterOrder": [ "name" ], "parameters": { +"allowMissing": { +"description": "Optional. If set to true, and the MessageBus is not found, the request will succeed but no action will be taken on the server.", +"location": "query", +"type": "boolean" +}, +"etag": { +"description": "Optional. If provided, the MessageBus will only be deleted if the etag matches the current etag on the resource.", +"location": "query", +"type": "string" +}, "name": { -"description": "The name of the operation resource to be deleted.", +"description": "Required. The name of the GoogleApiSource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/googleApiSources/[^/]+$", "required": true, "type": "string" +}, +"validateOnly": { +"description": "Optional. If set, validate the request and preview the review, but do not post it.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}", "response": { -"$ref": "Empty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"description": "Get a single GoogleApiSource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/googleApiSources/{googleApiSourcesId}", "httpMethod": "GET", -"id": "eventarc.projects.locations.operations.get", +"id": "eventarc.projects.locations.googleApiSources.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. The name of the google api source to get.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/googleApiSources/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleApiSource" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/googleApiSources/{googleApiSourcesId}:getIamPolicy", +"httpMethod": "GET", +"id": "eventarc.projects.locations.googleApiSources.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/googleApiSources/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "List GoogleApiSources.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/googleApiSources", +"httpMethod": "GET", +"id": "eventarc.projects.locations.googleApiSources.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The filter field that the list request will filter on. Possible filtersare described in https://google.aip.dev/160.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a `desc` suffix; for example: `name desc, update_time`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of results to return on each page. Note: The service may send fewer.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The page token; provide the value from the `next_page_token` field in a previous call to retrieve the subsequent page. When paginating, all other parameters provided must match the previous call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent collection to list GoogleApiSources on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/googleApiSources", +"response": { +"$ref": "ListGoogleApiSourcesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Update a single GoogleApiSource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/googleApiSources/{googleApiSourcesId}", +"httpMethod": "PATCH", +"id": "eventarc.projects.locations.googleApiSources.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"allowMissing": { +"description": "Optional. If set to true, and the GoogleApiSource is not found, a new GoogleApiSource will be created. In this situation, `update_mask` is ignored.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/googleApiSources/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of \"*\".", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, validate the request and preview the review, but do not post it.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleApiSource" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/googleApiSources/{googleApiSourcesId}:setIamPolicy", +"httpMethod": "POST", +"id": "eventarc.projects.locations.googleApiSources.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/googleApiSources/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/googleApiSources/{googleApiSourcesId}:testIamPermissions", +"httpMethod": "POST", +"id": "eventarc.projects.locations.googleApiSources.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/googleApiSources/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"messageBuses": { +"methods": { +"create": { +"description": "Create a new MessageBus in a particular project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/messageBuses", +"httpMethod": "POST", +"id": "eventarc.projects.locations.messageBuses.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"messageBusId": { +"description": "Required. The user-provided ID to be assigned to the MessageBus. It should match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$)", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent collection in which to add this message bus.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, validate the request and preview the review, but do not post it.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+parent}/messageBuses", +"request": { +"$ref": "MessageBus" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Delete a single message bus.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/messageBuses/{messageBusesId}", +"httpMethod": "DELETE", +"id": "eventarc.projects.locations.messageBuses.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"allowMissing": { +"description": "Optional. If set to true, and the MessageBus is not found, the request will succeed but no action will be taken on the server.", +"location": "query", +"type": "boolean" +}, +"etag": { +"description": "Optional. If provided, the MessageBus will only be deleted if the etag matches the current etag on the resource.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the MessageBus to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/messageBuses/[^/]+$", +"required": true, +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, validate the request and preview the review, but do not post it.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Get a single MessageBus.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/messageBuses/{messageBusesId}", +"httpMethod": "GET", +"id": "eventarc.projects.locations.messageBuses.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the message bus to get.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/messageBuses/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "MessageBus" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/messageBuses/{messageBusesId}:getIamPolicy", +"httpMethod": "GET", +"id": "eventarc.projects.locations.messageBuses.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/messageBuses/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "List message buses.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/messageBuses", +"httpMethod": "GET", +"id": "eventarc.projects.locations.messageBuses.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The filter field that the list request will filter on. Possible filtersare described in https://google.aip.dev/160.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a `desc` suffix; for example: `name desc, update_time`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of results to return on each page. Note: The service may send fewer.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The page token; provide the value from the `next_page_token` field in a previous call to retrieve the subsequent page. When paginating, all other parameters provided must match the previous call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent collection to list triggers on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/messageBuses", +"response": { +"$ref": "ListMessageBusesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"listEnrollments": { +"description": "List message bus enrollments.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/messageBuses/{messageBusesId}:listEnrollments", +"httpMethod": "GET", +"id": "eventarc.projects.locations.messageBuses.listEnrollments", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of results to return on each page. Note: The service may send fewer.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The page token; provide the value from the `next_page_token` field in a previous call to retrieve the subsequent page. When paginating, all other parameters provided must match the previous call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent message bus to list enrollments on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/messageBuses/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}:listEnrollments", +"response": { +"$ref": "ListMessageBusEnrollmentsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Update a single message bus.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/messageBuses/{messageBusesId}", +"httpMethod": "PATCH", +"id": "eventarc.projects.locations.messageBuses.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"allowMissing": { +"description": "Optional. If set to true, and the MessageBus is not found, a new MessageBus will be created. In this situation, `update_mask` is ignored.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/messageBuses/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of \"*\".", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, validate the request and preview the review, but do not post it.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "MessageBus" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/messageBuses/{messageBusesId}:setIamPolicy", +"httpMethod": "POST", +"id": "eventarc.projects.locations.messageBuses.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/messageBuses/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/messageBuses/{messageBusesId}:testIamPermissions", +"httpMethod": "POST", +"id": "eventarc.projects.locations.messageBuses.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/messageBuses/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "eventarc.projects.locations.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"request": { +"$ref": "GoogleLongrunningCancelOperationRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "eventarc.projects.locations.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "eventarc.projects.locations.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "id": "eventarc.projects.locations.operations.list", "parameterOrder": [ @@ -1096,44 +1711,237 @@ "type": "string" } }, -"path": "v1/{+name}/operations", +"path": "v1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"pipelines": { +"methods": { +"create": { +"description": "Create a new Pipeline in a particular project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelines", +"httpMethod": "POST", +"id": "eventarc.projects.locations.pipelines.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent collection in which to add this pipeline.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"pipelineId": { +"description": "Required. The user-provided ID to be assigned to the Pipeline.", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, validate the request and preview the review, but do not post it.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+parent}/pipelines", +"request": { +"$ref": "Pipeline" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Delete a single pipeline.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}", +"httpMethod": "DELETE", +"id": "eventarc.projects.locations.pipelines.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"allowMissing": { +"description": "Optional. If set to true, and the Pipeline is not found, the request will succeed but no action will be taken on the server.", +"location": "query", +"type": "boolean" +}, +"etag": { +"description": "Optional. If provided, the Pipeline will only be deleted if the etag matches the current etag on the resource.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the Pipeline to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/pipelines/[^/]+$", +"required": true, +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, validate the request and preview the review, but do not post it.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Get a single Pipeline.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}", +"httpMethod": "GET", +"id": "eventarc.projects.locations.pipelines.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the pipeline to get.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/pipelines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Pipeline" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:getIamPolicy", +"httpMethod": "GET", +"id": "eventarc.projects.locations.pipelines.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/pipelines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "List pipelines.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelines", +"httpMethod": "GET", +"id": "eventarc.projects.locations.pipelines.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The filter field that the list request will filter on. Possible filters are described in https://google.aip.dev/160.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a `desc` suffix; for example: `name desc, update_time`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of results to return on each page. Note: The service may send fewer.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The page token; provide the value from the `next_page_token` field in a previous call to retrieve the subsequent page. When paginating, all other parameters provided must match the previous call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent collection to list pipelines on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/pipelines", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "ListPipelinesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} }, -"pipelines": { -"methods": { -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:getIamPolicy", -"httpMethod": "GET", -"id": "eventarc.projects.locations.pipelines.getIamPolicy", +"patch": { +"description": "Update a single pipeline.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}", +"httpMethod": "PATCH", +"id": "eventarc.projects.locations.pipelines.patch", "parameterOrder": [ -"resource" +"name" ], "parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", +"allowMissing": { +"description": "Optional. If set to true, and the Pipeline is not found, a new Pipeline will be created. In this situation, `update_mask` is ignored.", "location": "query", -"type": "integer" +"type": "boolean" }, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"name": { +"description": "Identifier. The resource name of the Pipeline. Must be unique within the location of the project and must be in `projects/{project}/locations/{location}/pipelines/{pipeline}` format.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/pipelines/[^/]+$", "required": true, "type": "string" +}, +"updateMask": { +"description": "Optional. The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of \"*\".", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, validate the request and preview the review, but do not post it.", +"location": "query", +"type": "boolean" } }, -"path": "v1/{+resource}:getIamPolicy", +"path": "v1/{+name}", +"request": { +"$ref": "Pipeline" +}, "response": { -"$ref": "Policy" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -1561,7 +2369,7 @@ } } }, -"revision": "20240913", +"revision": "20241021", "rootUrl": "https://eventarc.googleapis.com/", "schemas": { "AuditConfig": { @@ -1794,6 +2602,69 @@ "properties": {}, "type": "object" }, +"Enrollment": { +"description": "An enrollment represents a subscription for messages on a particular message bus. It defines a matching criteria for messages on the bus and the subscriber endpoint where matched messages should be delivered.", +"id": "Enrollment", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Resource annotations.", +"type": "object" +}, +"celMatch": { +"description": "Required. A CEL expression identifying which messages this enrollment applies to.", +"type": "string" +}, +"createTime": { +"description": "Output only. The creation time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"destination": { +"description": "Required. Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: \"projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)\"", +"type": "string" +}, +"displayName": { +"description": "Optional. Resource display name.", +"type": "string" +}, +"etag": { +"description": "Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Resource labels.", +"type": "object" +}, +"messageBus": { +"description": "Required. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.", +"type": "string" +}, +"name": { +"description": "Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}", +"type": "string" +}, +"uid": { +"description": "Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The last-modified time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "EventFilter": { "description": "Filters events based on exact matches on the CloudEvents attributes.", "id": "EventFilter", @@ -1885,57 +2756,317 @@ "readOnly": true, "type": "boolean" }, -"required": { -"description": "Output only. If true, the triggers for this provider should always specify a filter on these attributes. Trigger creation will fail otherwise.", -"readOnly": true, -"type": "boolean" +"required": { +"description": "Output only. If true, the triggers for this provider should always specify a filter on these attributes. Trigger creation will fail otherwise.", +"readOnly": true, +"type": "boolean" +} +}, +"type": "object" +}, +"GKE": { +"description": "Represents a GKE destination.", +"id": "GKE", +"properties": { +"cluster": { +"description": "Required. The name of the cluster the GKE service is running in. The cluster must be running in the same project as the trigger being created.", +"type": "string" +}, +"location": { +"description": "Required. The name of the Google Compute Engine in which the cluster resides, which can either be compute zone (for example, us-central1-a) for the zonal clusters or region (for example, us-central1) for regional clusters.", +"type": "string" +}, +"namespace": { +"description": "Required. The namespace the GKE service is running in.", +"type": "string" +}, +"path": { +"description": "Optional. The relative path on the GKE service the events should be sent to. The value must conform to the definition of a URI path segment (section 3.3 of RFC2396). Examples: \"/route\", \"route\", \"route/subroute\".", +"type": "string" +}, +"service": { +"description": "Required. Name of the GKE service.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleApiSource": { +"description": "A GoogleApiSource represents a subscription of 1P events from a MessageBus.", +"id": "GoogleApiSource", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Resource annotations.", +"type": "object" +}, +"createTime": { +"description": "Output only. The creation time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"cryptoKeyName": { +"description": "Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.", +"type": "string" +}, +"destination": { +"description": "Required. Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: \"projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)", +"type": "string" +}, +"displayName": { +"description": "Optional. Resource display name.", +"type": "string" +}, +"etag": { +"description": "Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Resource labels.", +"type": "object" +}, +"loggingConfig": { +"$ref": "LoggingConfig", +"description": "Optional. Config to control Platform logging for the GoogleApiSource." +}, +"name": { +"description": "Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}", +"type": "string" +}, +"uid": { +"description": "Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The last-modified time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleChannelConfig": { +"description": "A GoogleChannelConfig is a resource that stores the custom settings respected by Eventarc first-party triggers in the matching region. Once configured, first-party event data will be protected using the specified custom managed encryption key instead of Google-managed encryption keys.", +"id": "GoogleChannelConfig", +"properties": { +"cryptoKeyName": { +"description": "Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.", +"type": "string" +}, +"name": { +"description": "Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`.", +"type": "string" +}, +"updateTime": { +"description": "Output only. The last-modified time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudEventarcV1PipelineDestination": { +"description": "Represents a target of an invocation over HTTP.", +"id": "GoogleCloudEventarcV1PipelineDestination", +"properties": { +"authenticationConfig": { +"$ref": "GoogleCloudEventarcV1PipelineDestinationAuthenticationConfig", +"description": "Optional. An authentication config used to authenticate message requests, such that destinations can verify the source. For example, this can be used with private GCP destinations that require GCP credentials to access like Cloud Run. This field is optional and should be set only by users interested in authenticated push" +}, +"httpEndpoint": { +"$ref": "GoogleCloudEventarcV1PipelineDestinationHttpEndpoint", +"description": "Optional. An HTTP endpoint destination described by an URI. If a DNS FQDN is provided as the endpoint, Pipeline will create a peering zone to the consumer VPC and forward DNS requests to the VPC specified by network config to resolve the service endpoint. See: https://cloud.google.com/dns/docs/zones/zones-overview#peering_zones" +}, +"messageBus": { +"description": "Optional. The resource name of the Message Bus to which events should be published. The Message Bus resource should exist in the same project as the Pipeline. Format: `projects/{project}/locations/{location}/messageBuses/{message_bus}`", +"type": "string" +}, +"networkConfig": { +"$ref": "GoogleCloudEventarcV1PipelineDestinationNetworkConfig", +"description": "Optional. Network config is used to configure how Pipeline resolves and connects to a destination." +}, +"outputPayloadFormat": { +"$ref": "GoogleCloudEventarcV1PipelineMessagePayloadFormat", +"description": "Optional. The message format before it is delivered to the destination. If not set, the message will be delivered in the format it was originally delivered to the Pipeline. This field can only be set if Pipeline.input_payload_format is also set." +}, +"topic": { +"description": "Optional. The resource name of the Pub/Sub topic to which events should be published. Format: `projects/{project}/locations/{location}/topics/{topic}`", +"type": "string" +}, +"workflow": { +"description": "Optional. The resource name of the Workflow whose Executions are triggered by the events. The Workflow resource should be deployed in the same project as the Pipeline. Format: `projects/{project}/locations/{location}/workflows/{workflow}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudEventarcV1PipelineDestinationAuthenticationConfig": { +"description": "Represents a config used to authenticate message requests.", +"id": "GoogleCloudEventarcV1PipelineDestinationAuthenticationConfig", +"properties": { +"googleOidc": { +"$ref": "GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOidcToken", +"description": "Optional. This authenticate method will apply Google OIDC tokens signed by a GCP service account to the requests." +}, +"oauthToken": { +"$ref": "GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOAuthToken", +"description": "Optional. If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com." +} +}, +"type": "object" +}, +"GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOAuthToken": { +"description": "Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.", +"id": "GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOAuthToken", +"properties": { +"scope": { +"description": "Optional. OAuth scope to be used for generating OAuth access token. If not specified, \"https://www.googleapis.com/auth/cloud-platform\" will be used.", +"type": "string" +}, +"serviceAccount": { +"description": "Required. Service account email used to generate the [OAuth token](https://developers.google.com/identity/protocols/OAuth2). The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow Pipeline to create OAuth2 tokens for authenticated requests.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOidcToken": { +"description": "Represents a config used to authenticate with a Google OIDC token using a GCP service account. Use this authentication method to invoke your Cloud Run and Cloud Functions destinations or HTTP endpoints that support Google OIDC.", +"id": "GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOidcToken", +"properties": { +"audience": { +"description": "Optional. Audience to be used to generate the OIDC Token. The audience claim identifies the recipient that the JWT is intended for. If unspecified, the destination URI will be used.", +"type": "string" +}, +"serviceAccount": { +"description": "Required. Service account email used to generate the OIDC Token. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow the Pipeline to create OpenID tokens for authenticated requests.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudEventarcV1PipelineDestinationHttpEndpoint": { +"description": "Represents a HTTP endpoint destination.", +"id": "GoogleCloudEventarcV1PipelineDestinationHttpEndpoint", +"properties": { +"messageBindingTemplate": { +"description": "Optional. The CEL expression used to construct a new HTTP request to be sent to the final destination. The result of the CEL expression must be a map of key/value pairs such that: - If a map named `headers` exists on the result of the expression, then its key/value pairs are directly mapped to the HTTP request headers. The headers values are constructed from the corresponding value type\u2019s canonical representation. If the `headers` field doesn\u2019t exist then the resulting HTTP request will be without headers. - If a field named `body` exists on the result of the expression then its value is directly mapped to the body of the request. If the value of the `body` field is of type bytes or string then it is used for the HTTP request body as-is, with no conversion. If the body field is of any other type then it is converted to a JSON string. If the body field doesn\u2019t exist then the resulting HTTP request will be without a body. - Any other fields in the resulting expression will be ignored. The CEL expression may access the incoming CloudEvent message in its definition, as follows: - The `data` field of the incoming CloudEvent message can be accessed using the `message.data` value. - Each attribute of the incoming CloudEvent message can be accessed using the `message.` value, where is replaced with the name of the attribute. Headers added to the request by previous filters in the chain can be accessed in the CEL expression using the `headers` variable. The `headers` variable defines a map of key/value pairs corresponding to the HTTP headers added by previous mediation steps and not the headers present on the original incoming request. For example, the following CEL expression can be used to construct a Headers-only HTTP request by adding an additional header to the headers added by previous mediations in the Pipeline: ``` {\"headers\": headers.merge({\"new-header-key\": \"new-header-value\"})} ``` Additionally, the following CEL extension functions are provided for use in this CEL expression: - toBase64Url: map.toBase64Url() -> string - Converts a CelValue to a base64url encoded string - toJsonString: map.toJsonString() -> string - Converts a CelValue to a JSON string - merge: map1.merge(map2) -> map3 - Merges the passed CEL map with the existing CEL map the function is applied to. - If the same key exists in both maps, if the key's value is type map both maps are merged else the value from the passed map is used. - toMap: list(map).toMap() -> map - Converts a CEL list of CEL maps to a single CEL map - toDestinationPayloadFormat(): message.data.toDestinationPayloadFormat() -> string or bytes - Converts the message data to the destination payload format specified in Pipeline.Destination.output_payload_format - This function is meant to be applied to the message.data field. - If the destination payload format is not set, the function will return the message data unchanged. - toCloudEventJsonWithPayloadFormat: message.toCloudEventJsonWithPayloadFormat() -> map - Converts a message to the corresponding structure of JSON format for CloudEvents - This function applies toDestinationPayloadFormat() to the message data. It also sets the corresponding datacontenttype of the CloudEvent, as indicated by Pipeline.Destination.output_payload_format. If no output_payload_format is set it will use the existing datacontenttype on the CloudEvent if present, else leave datacontenttype absent. - This function expects that the content of the message will adhere to the standard CloudEvent format. If it doesn\u2019t then this function will fail. - The result is a CEL map that corresponds to the JSON representation of the CloudEvent. To convert that data to a JSON string it can be chained with the toJsonString function. If a binding is not specified here, by default the message is treated as a CloudEvent and is mapped to the HTTP request according to the CloudEvent HTTP Protocol Binding Binary Content Mode. The Pipeline converts the data field of the message to the format provided in Pipeline.Destination.output_payload_format and maps it to the body field of the result. It also sets the corresponding Content-Type header to the output_payload_format type. If the Pipeline.Destination.output_payload_format is not set, then the Pipeline will treat the data field of the message as opaque binary data and attach it to the request body as bytes. In this case the Content-type header will be set to the value of the datacontenttype attribute set on the incoming CloudEvent message if present and the `application/octet-stream` MIME type otherwise. The Pipeline expects that the content of the message will adhere to the standard CloudEvent format. If it doesn\u2019t then the outgoing message request may fail with a persistent error.", +"type": "string" +}, +"uri": { +"description": "Required. The URI of the HTTP enpdoint. The value must be a RFC2396 URI string. Examples: `http://10.10.10.8:80/route`, `http://svc.us-central1.p.local:8080/`. Only HTTP and HTTPS protocols are supported. The host can be either a static IP addressable from the VPC specified by the network config, or an internal DNS hostname of the service resolvable via Cloud DNS.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudEventarcV1PipelineDestinationNetworkConfig": { +"description": "Represents a network config to be used for destination resolution and connectivity.", +"id": "GoogleCloudEventarcV1PipelineDestinationNetworkConfig", +"properties": { +"networkAttachment": { +"description": "Required. Name of the NetworkAttachment that allows access to the consumer VPC. Format: `projects/{PROJECT_ID}/regions/{REGION}/networkAttachments/{NETWORK_ATTACHMENT_NAME}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudEventarcV1PipelineMediation": { +"description": "Mediation defines different ways to modify the Pipeline.", +"id": "GoogleCloudEventarcV1PipelineMediation", +"properties": { +"transformation": { +"$ref": "GoogleCloudEventarcV1PipelineMediationTransformation", +"description": "Optional. How the Pipeline is to transform messages" } }, "type": "object" }, -"GKE": { -"description": "Represents a GKE destination.", -"id": "GKE", +"GoogleCloudEventarcV1PipelineMediationTransformation": { +"description": "Transformation defines the way to transform an incoming message.", +"id": "GoogleCloudEventarcV1PipelineMediationTransformation", "properties": { -"cluster": { -"description": "Required. The name of the cluster the GKE service is running in. The cluster must be running in the same project as the trigger being created.", +"transformationTemplate": { +"description": "Optional. The template to apply to transform messages.", "type": "string" +} }, -"location": { -"description": "Required. The name of the Google Compute Engine in which the cluster resides, which can either be compute zone (for example, us-central1-a) for the zonal clusters or region (for example, us-central1) for regional clusters.", -"type": "string" +"type": "object" }, -"namespace": { -"description": "Required. The namespace the GKE service is running in.", -"type": "string" +"GoogleCloudEventarcV1PipelineMessagePayloadFormat": { +"description": "Represents the format of message data.", +"id": "GoogleCloudEventarcV1PipelineMessagePayloadFormat", +"properties": { +"avro": { +"$ref": "GoogleCloudEventarcV1PipelineMessagePayloadFormatAvroFormat", +"description": "Optional. Avro format." }, -"path": { -"description": "Optional. The relative path on the GKE service the events should be sent to. The value must conform to the definition of a URI path segment (section 3.3 of RFC2396). Examples: \"/route\", \"route\", \"route/subroute\".", -"type": "string" +"json": { +"$ref": "GoogleCloudEventarcV1PipelineMessagePayloadFormatJsonFormat", +"description": "Optional. JSON format." }, -"service": { -"description": "Required. Name of the GKE service.", +"protobuf": { +"$ref": "GoogleCloudEventarcV1PipelineMessagePayloadFormatProtobufFormat", +"description": "Optional. Protobuf format." +} +}, +"type": "object" +}, +"GoogleCloudEventarcV1PipelineMessagePayloadFormatAvroFormat": { +"description": "The format of an AVRO message payload.", +"id": "GoogleCloudEventarcV1PipelineMessagePayloadFormatAvroFormat", +"properties": { +"schemaDefinition": { +"description": "Optional. The entire schema definition is stored in this field.", "type": "string" } }, "type": "object" }, -"GoogleChannelConfig": { -"description": "A GoogleChannelConfig is a resource that stores the custom settings respected by Eventarc first-party triggers in the matching region. Once configured, first-party event data will be protected using the specified custom managed encryption key instead of Google-managed encryption keys.", -"id": "GoogleChannelConfig", +"GoogleCloudEventarcV1PipelineMessagePayloadFormatJsonFormat": { +"description": "The format of a JSON message payload.", +"id": "GoogleCloudEventarcV1PipelineMessagePayloadFormatJsonFormat", +"properties": {}, +"type": "object" +}, +"GoogleCloudEventarcV1PipelineMessagePayloadFormatProtobufFormat": { +"description": "The format of a Protobuf message payload.", +"id": "GoogleCloudEventarcV1PipelineMessagePayloadFormatProtobufFormat", "properties": { -"cryptoKeyName": { -"description": "Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.", +"schemaDefinition": { +"description": "Optional. The entire schema definition is stored in this field.", "type": "string" +} }, -"name": { -"description": "Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`.", +"type": "object" +}, +"GoogleCloudEventarcV1PipelineRetryPolicy": { +"description": "The retry policy configuration for the Pipeline. The pipeline exponentially backs off in case the destination is non responsive or returns a retryable error code. The default semantics are as follows: The backoff starts with a 5 second delay and doubles the delay after each failed attempt (10 seconds, 20 seconds, 40 seconds, etc.). The delay is capped at 60 seconds by default. Please note that if you set the min_retry_delay and max_retry_delay fields to the same value this will make the duration between retries constant.", +"id": "GoogleCloudEventarcV1PipelineRetryPolicy", +"properties": { +"maxAttempts": { +"description": "Optional. The maximum number of delivery attempts for any message. The value must be between 1 and 100. The default value for this field is 5.", +"format": "int32", +"type": "integer" +}, +"maxRetryDelay": { +"description": "Optional. The maximum amount of seconds to wait between retry attempts. The value must be between 0 and 600. The default value for this field is 60.", +"format": "google-duration", "type": "string" }, -"updateTime": { -"description": "Output only. The last-modified time.", -"format": "google-datetime", -"readOnly": true, +"minRetryDelay": { +"description": "Optional. The minimum amount of seconds to wait between retry attempts. The value must be between 0 and 600. The default value for this field is 5.", +"format": "google-duration", "type": "string" } }, @@ -2088,6 +3219,56 @@ }, "type": "object" }, +"ListEnrollmentsResponse": { +"description": "The response message for the `ListEnrollments` method.", +"id": "ListEnrollmentsResponse", +"properties": { +"enrollments": { +"description": "The requested Enrollments, up to the number specified in `page_size`.", +"items": { +"$ref": "Enrollment" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A page token that can be sent to `ListEnrollments` to request the next page. If this is empty, then there are no more pages.", +"type": "string" +}, +"unreachable": { +"description": "Unreachable resources, if any.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListGoogleApiSourcesResponse": { +"description": "The response message for the `ListGoogleApiSources` method.", +"id": "ListGoogleApiSourcesResponse", +"properties": { +"googleApiSources": { +"description": "The requested GoogleApiSources, up to the number specified in `page_size`.", +"items": { +"$ref": "GoogleApiSource" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A page token that can be sent to `ListMessageBusEnrollments` to request the next page. If this is empty, then there are no more pages.", +"type": "string" +}, +"unreachable": { +"description": "Unreachable resources, if any.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse", @@ -2106,6 +3287,81 @@ }, "type": "object" }, +"ListMessageBusEnrollmentsResponse": { +"description": "The response message for the `ListMessageBusEnrollments` method.`", +"id": "ListMessageBusEnrollmentsResponse", +"properties": { +"enrollments": { +"description": "The requested enrollments, up to the number specified in `page_size`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A page token that can be sent to `ListMessageBusEnrollments` to request the next page. If this is empty, then there are no more pages.", +"type": "string" +}, +"unreachable": { +"description": "Unreachable resources, if any.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListMessageBusesResponse": { +"description": "The response message for the `ListMessageBuses` method.", +"id": "ListMessageBusesResponse", +"properties": { +"messageBuses": { +"description": "The requested message buses, up to the number specified in `page_size`.", +"items": { +"$ref": "MessageBus" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A page token that can be sent to `ListMessageBuses` to request the next page. If this is empty, then there are no more pages.", +"type": "string" +}, +"unreachable": { +"description": "Unreachable resources, if any.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListPipelinesResponse": { +"description": "The response message for the ListPipelines method.", +"id": "ListPipelinesResponse", +"properties": { +"nextPageToken": { +"description": "A page token that can be sent to `ListPipelines` to request the next page. If this is empty, then there are no more pages.", +"type": "string" +}, +"pipelines": { +"description": "The requested pipelines, up to the number specified in `page_size`.", +"items": { +"$ref": "Pipeline" +}, +"type": "array" +}, +"unreachable": { +"description": "Unreachable resources, if any.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListProvidersResponse": { "description": "The response message for the `ListProviders` method.", "id": "ListProvidersResponse", @@ -2190,6 +3446,100 @@ }, "type": "object" }, +"LoggingConfig": { +"description": "The configuration for Platform Telemetry logging for Eventarc Avdvanced resources.", +"id": "LoggingConfig", +"properties": { +"logSeverity": { +"description": "Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy \u2265 this value will be sent, unless it is NONE.", +"enum": [ +"LOG_SEVERITY_UNSPECIFIED", +"NONE", +"DEBUG", +"INFO", +"NOTICE", +"WARNING", +"ERROR", +"CRITICAL", +"ALERT", +"EMERGENCY" +], +"enumDescriptions": [ +"Log severity is not specified. This value is treated the same as NONE, but is used to distinguish between no update and update to NONE in update_masks.", +"Default value at resource creation, presence of this value must be treated as no logging/disable logging.", +"Debug or trace level logging.", +"Routine information, such as ongoing status or performance.", +"Normal but significant events, such as start up, shut down, or a configuration change.", +"Warning events might cause problems.", +"Error events are likely to cause problems.", +"Critical events cause more severe problems or outages.", +"A person must take action immediately.", +"One or more systems are unusable." +], +"type": "string" +} +}, +"type": "object" +}, +"MessageBus": { +"description": "MessageBus for the messages flowing through the system. The admin has visibility and control over the messages being published and consumed and can restrict publishers and subscribers to only a subset of data available in the system by defining authorization policies.", +"id": "MessageBus", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Resource annotations.", +"type": "object" +}, +"createTime": { +"description": "Output only. The creation time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"cryptoKeyName": { +"description": "Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.", +"type": "string" +}, +"displayName": { +"description": "Optional. Resource display name.", +"type": "string" +}, +"etag": { +"description": "Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Resource labels.", +"type": "object" +}, +"loggingConfig": { +"$ref": "LoggingConfig", +"description": "Optional. Config to control Platform logging for the Message Bus. This log configuration is applied to the Message Bus itself, and all the Enrollments attached to it." +}, +"name": { +"description": "Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}", +"type": "string" +}, +"uid": { +"description": "Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The last-modified time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "NetworkConfig": { "description": "Network Configuration that can be inherited by other protos.", "id": "NetworkConfig", @@ -2245,6 +3595,86 @@ }, "type": "object" }, +"Pipeline": { +"description": "A representation of the Pipeline resource.", +"id": "Pipeline", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. User-defined annotations. See https://google.aip.dev/128#annotations.", +"type": "object" +}, +"createTime": { +"description": "Output only. The creation time. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: \"2014-10-02T15:01:23Z\" and \"2014-10-02T15:01:23.045123456Z\".", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"cryptoKeyName": { +"description": "Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt the event data. If not set, an internal Google-owned key will be used to encrypt messages. It must match the pattern \"projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}\".", +"type": "string" +}, +"destinations": { +"description": "Required. List of destinations to which messages will be forwarded. Currently, exactly one destination is supported per Pipeline.", +"items": { +"$ref": "GoogleCloudEventarcV1PipelineDestination" +}, +"type": "array" +}, +"displayName": { +"description": "Optional. Display name of resource.", +"type": "string" +}, +"etag": { +"description": "Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on create requests to ensure that the client has an up-to-date value before proceeding.", +"type": "string" +}, +"inputPayloadFormat": { +"$ref": "GoogleCloudEventarcV1PipelineMessagePayloadFormat", +"description": "Optional. The payload format expected for the messages received by the Pipeline. If input_payload_format is set then any messages not matching this format will be treated as persistent errors. If input_payload_format is not set, then the message data will be treated as an opaque binary and no output format can be set on the Pipeline through the Pipeline.Destination.output_payload_format field. Any Mediations on the Pipeline that involve access to the data field will fail as persistent errors." +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. User labels attached to the Pipeline that can be used to group resources. An object containing a list of \"key\": value pairs. Example: { \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }.", +"type": "object" +}, +"loggingConfig": { +"$ref": "LoggingConfig", +"description": "Optional. Config to control Platform Logging for Pipelines." +}, +"mediations": { +"description": "Optional. List of mediation operations to be performed on the message. Currently, only one Transformation operation is allowed in each Pipeline.", +"items": { +"$ref": "GoogleCloudEventarcV1PipelineMediation" +}, +"type": "array" +}, +"name": { +"description": "Identifier. The resource name of the Pipeline. Must be unique within the location of the project and must be in `projects/{project}/locations/{location}/pipelines/{pipeline}` format.", +"type": "string" +}, +"retryPolicy": { +"$ref": "GoogleCloudEventarcV1PipelineRetryPolicy", +"description": "Optional. The retry policy to use in the pipeline." +}, +"uid": { +"description": "Output only. Server-assigned unique identifier for the Pipeline. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The last-modified time. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: \"2014-10-02T15:01:23Z\" and \"2014-10-02T15:01:23.045123456Z\".", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Policy": { "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", diff --git a/googleapiclient/discovery_cache/documents/file.v1.json b/googleapiclient/discovery_cache/documents/file.v1.json index 7ee836e4e5..bee5ac9e00 100644 --- a/googleapiclient/discovery_cache/documents/file.v1.json +++ b/googleapiclient/discovery_cache/documents/file.v1.json @@ -902,7 +902,7 @@ } } }, -"revision": "20240905", +"revision": "20241015", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1144,8 +1144,14 @@ "description": "Fixed IOPS (input/output operations per second) parameters.", "id": "FixedIOPS", "properties": { +"maxIops": { +"description": "Required. Maximum IOPS.", +"format": "int64", +"type": "string" +}, "maxReadIops": { -"description": "Required. Maximum raw read IOPS.", +"deprecated": true, +"description": "Optional. Deprecated: `max_iops` should be used instead of this parameter. Maximum raw read IOPS.", "format": "int64", "type": "string" } @@ -1431,8 +1437,14 @@ "description": "IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB).", "id": "IOPSPerTB", "properties": { +"maxIopsPerTb": { +"description": "Required. Maximum IOPS per TiB.", +"format": "int64", +"type": "string" +}, "maxReadIopsPerTb": { -"description": "Required. Maximum read IOPS per TiB.", +"deprecated": true, +"description": "Optional. Deprecated: `max_iops_per_tb` should be used instead of this parameter. Maximum read IOPS per TiB.", "format": "int64", "type": "string" } @@ -2302,22 +2314,22 @@ "id": "TimeOfDay", "properties": { "hours": { -"description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", +"description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, "minutes": { -"description": "Minutes of hour of day. Must be from 0 to 59.", +"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "type": "integer" }, "nanos": { -"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", +"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32", "type": "integer" }, "seconds": { -"description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", +"description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } diff --git a/googleapiclient/discovery_cache/documents/file.v1beta1.json b/googleapiclient/discovery_cache/documents/file.v1beta1.json index b194592b44..43c66b1c66 100644 --- a/googleapiclient/discovery_cache/documents/file.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/file.v1beta1.json @@ -1069,7 +1069,7 @@ } } }, -"revision": "20240905", +"revision": "20241015", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1322,8 +1322,14 @@ "description": "Fixed IOPS (input/output operations per second) parameters.", "id": "FixedIOPS", "properties": { +"maxIops": { +"description": "Required. Maximum raw IOPS.", +"format": "int64", +"type": "string" +}, "maxReadIops": { -"description": "Required. Maximum raw read IOPS.", +"deprecated": true, +"description": "Optional. Deprecated: `max_iops` should be used instead of this parameter. Maximum raw read IOPS.", "format": "int64", "type": "string" } @@ -1609,8 +1615,14 @@ "description": "IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB).", "id": "IOPSPerTB", "properties": { +"maxIopsPerTb": { +"description": "Required. Maximum IOPS per TiB.", +"format": "int64", +"type": "string" +}, "maxReadIopsPerTb": { -"description": "Required. Maximum read IOPS per TiB.", +"deprecated": true, +"description": "Optional. Deprecated: `max_iops_per_tb` should be used instead of this parameter. Maximum read IOPS per TiB.", "format": "int64", "type": "string" } @@ -2639,22 +2651,22 @@ "id": "TimeOfDay", "properties": { "hours": { -"description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", +"description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, "minutes": { -"description": "Minutes of hour of day. Must be from 0 to 59.", +"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "type": "integer" }, "nanos": { -"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", +"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32", "type": "integer" }, "seconds": { -"description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", +"description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json index e1378493b8..9a9f23474f 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json @@ -557,6 +557,21 @@ "pattern": "^projects/[^/]+/apps/[^/]+/releases/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "Optional. The requested view on the returned ReleaseTests. Defaults to the basic view.", +"enum": [ +"RELEASE_TEST_VIEW_UNSPECIFIED", +"RELEASE_TEST_VIEW_BASIC", +"RELEASE_TEST_VIEW_FULL" +], +"enumDescriptions": [ +"The default / unset value. The default view depends on the RPC.", +"Include basic metadata about the release test and its status, but not the full result details. This is the default value for ListReleaseTests.", +"Include everything." +], +"location": "query", +"type": "string" } }, "path": "v1alpha/{+parent}/tests", @@ -610,7 +625,7 @@ } } }, -"revision": "20241011", +"revision": "20241018", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "AndroidxCrawlerOutputPoint": { @@ -1071,6 +1086,11 @@ "description": "An interaction with the device, such as a tap, text entry, wait, etc.", "id": "GoogleFirebaseAppdistroV1alphaDeviceInteraction", "properties": { +"keyCode": { +"description": "Output only. Key code for a key event action.", +"readOnly": true, +"type": "string" +}, "screenshot": { "$ref": "GoogleFirebaseAppdistroV1alphaScreenshot", "description": "Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken.", diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index bdb5747ae7..54ee336ff0 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20241010", +"revision": "20241024", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -291,7 +291,7 @@ "Token generation reached a natural stopping point or a configured stop sequence.", "Token generation reached the configured maximum output tokens.", "Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, content is empty if content filters blocks the output.", -"Token generation stopped because the content potentially contains copyright violations.", +"The token generation stopped because of potential recitation.", "All other reasons that stopped the token generation.", "Token generation stopped because the content contains forbidden terms.", "Token generation stopped for potentially containing prohibited content.", @@ -596,7 +596,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1FunctionDeclaration": { -"description": "Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.", +"description": "Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.", "id": "GoogleCloudAiplatformV1beta1FunctionDeclaration", "properties": { "description": { @@ -1570,6 +1570,7 @@ "type": "array" }, "similarityTopK": { +"deprecated": true, "description": "Optional. Number of top k results to return from the selected corpora.", "format": "int32", "type": "integer" diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index f0ff64e08c..45f23d22c3 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -1711,7 +1711,7 @@ } } }, -"revision": "20240904", +"revision": "20241018", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2417,7 +2417,7 @@ "type": "string" }, "distanceThreshold": { -"description": "Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance >= distance_threshold", +"description": "Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold", "format": "double", "type": "number" }, @@ -4264,7 +4264,7 @@ "type": "object" }, "StructuredQuery": { -"description": "A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit", +"description": "A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest", "id": "StructuredQuery", "properties": { "endAt": { diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json index b46c56b627..317f3ce580 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json @@ -950,7 +950,7 @@ } } }, -"revision": "20240822", +"revision": "20241018", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -1656,7 +1656,7 @@ "type": "string" }, "distanceThreshold": { -"description": "Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance >= distance_threshold", +"description": "Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold", "format": "double", "type": "number" }, @@ -2654,7 +2654,7 @@ "type": "object" }, "StructuredQuery": { -"description": "A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit", +"description": "A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest", "id": "StructuredQuery", "properties": { "endAt": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index d9cd53a8cb..84506caf0b 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -2111,7 +2111,7 @@ } } }, -"revision": "20240920", +"revision": "20241017", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2649,7 +2649,8 @@ "description": "Git repo configuration for the cluster." }, "metricsGcpServiceAccountEmail": { -"description": "The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA.", +"deprecated": true, +"description": "The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring.", "type": "string" }, "oci": { @@ -2851,6 +2852,28 @@ "description": "State information for ConfigSync", "id": "ConfigManagementConfigSyncState", "properties": { +"clusterLevelStopSyncingState": { +"description": "Whether syncing resources to the cluster is stopped at the cluster level.", +"enum": [ +"STOP_SYNCING_STATE_UNSPECIFIED", +"NOT_STOPPED", +"PENDING", +"STOPPED" +], +"enumDescriptions": [ +"State cannot be determined", +"Syncing resources to the cluster is not stopped at the cluster level.", +"Some reconcilers stop syncing resources to the cluster, while others are still syncing.", +"Syncing resources to the cluster is stopped at the cluster level." +], +"type": "string" +}, +"crCount": { +"description": "Output only. The number of RootSync and RepoSync CRs in the cluster.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "deploymentState": { "$ref": "ConfigManagementConfigSyncDeploymentState", "description": "Information about the deployment of ConfigSync, including the version of the various Pods deployed" @@ -4843,6 +4866,21 @@ "$ref": "Authority", "description": "Optional. How to identify workloads from this Membership. See the documentation on Workload Identity for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity" }, +"clusterTier": { +"description": "Output only. The tier of the cluster.", +"enum": [ +"CLUSTER_TIER_UNSPECIFIED", +"STANDARD", +"ENTERPRISE" +], +"enumDescriptions": [ +"The ClusterTier is not set.", +"The ClusterTier is standard.", +"The ClusterTier is enterprise." +], +"readOnly": true, +"type": "string" +}, "createTime": { "description": "Output only. When the Membership was created.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index 53a1333c81..e2c2195586 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -2255,7 +2255,7 @@ } } }, -"revision": "20240920", +"revision": "20241017", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2994,7 +2994,8 @@ "description": "Git repo configuration for the cluster." }, "metricsGcpServiceAccountEmail": { -"description": "The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA.", +"deprecated": true, +"description": "The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring.", "type": "string" }, "oci": { @@ -3196,6 +3197,28 @@ "description": "State information for ConfigSync", "id": "ConfigManagementConfigSyncState", "properties": { +"clusterLevelStopSyncingState": { +"description": "Whether syncing resources to the cluster is stopped at the cluster level.", +"enum": [ +"STOP_SYNCING_STATE_UNSPECIFIED", +"NOT_STOPPED", +"PENDING", +"STOPPED" +], +"enumDescriptions": [ +"State cannot be determined", +"Syncing resources to the cluster is not stopped at the cluster level.", +"Some reconcilers stop syncing resources to the cluster, while others are still syncing.", +"Syncing resources to the cluster is stopped at the cluster level." +], +"type": "string" +}, +"crCount": { +"description": "Output only. The number of RootSync and RepoSync CRs in the cluster.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "deploymentState": { "$ref": "ConfigManagementConfigSyncDeploymentState", "description": "Information about the deployment of ConfigSync, including the version of the various Pods deployed" @@ -5266,6 +5289,21 @@ "$ref": "Authority", "description": "Optional. How to identify workloads from this Membership. See the documentation on Workload Identity for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity" }, +"clusterTier": { +"description": "Output only. The tier of the cluster.", +"enum": [ +"CLUSTER_TIER_UNSPECIFIED", +"STANDARD", +"ENTERPRISE" +], +"enumDescriptions": [ +"The ClusterTier is not set.", +"The ClusterTier is standard.", +"The ClusterTier is enterprise." +], +"readOnly": true, +"type": "string" +}, "createTime": { "description": "Output only. When the Membership was created.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index c586be1bd4..4cc5c604ec 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -2111,7 +2111,7 @@ } } }, -"revision": "20240920", +"revision": "20241017", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2734,7 +2734,8 @@ "description": "Git repo configuration for the cluster." }, "metricsGcpServiceAccountEmail": { -"description": "The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA.", +"deprecated": true, +"description": "The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring.", "type": "string" }, "oci": { @@ -2936,6 +2937,28 @@ "description": "State information for ConfigSync", "id": "ConfigManagementConfigSyncState", "properties": { +"clusterLevelStopSyncingState": { +"description": "Whether syncing resources to the cluster is stopped at the cluster level.", +"enum": [ +"STOP_SYNCING_STATE_UNSPECIFIED", +"NOT_STOPPED", +"PENDING", +"STOPPED" +], +"enumDescriptions": [ +"State cannot be determined", +"Syncing resources to the cluster is not stopped at the cluster level.", +"Some reconcilers stop syncing resources to the cluster, while others are still syncing.", +"Syncing resources to the cluster is stopped at the cluster level." +], +"type": "string" +}, +"crCount": { +"description": "Output only. The number of RootSync and RepoSync CRs in the cluster.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "deploymentState": { "$ref": "ConfigManagementConfigSyncDeploymentState", "description": "Information about the deployment of ConfigSync, including the version of the various Pods deployed" @@ -4937,6 +4960,21 @@ "$ref": "Authority", "description": "Optional. How to identify workloads from this Membership. See the documentation on Workload Identity for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity" }, +"clusterTier": { +"description": "Output only. The tier of the cluster.", +"enum": [ +"CLUSTER_TIER_UNSPECIFIED", +"STANDARD", +"ENTERPRISE" +], +"enumDescriptions": [ +"The ClusterTier is not set.", +"The ClusterTier is standard.", +"The ClusterTier is enterprise." +], +"readOnly": true, +"type": "string" +}, "createTime": { "description": "Output only. When the Membership was created.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2.json b/googleapiclient/discovery_cache/documents/gkehub.v2.json index 46fdb14a53..904b1197a3 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2.json @@ -471,7 +471,7 @@ } } }, -"revision": "20241006", +"revision": "20241017", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -714,7 +714,8 @@ "description": "Git repo configuration for the cluster." }, "metricsGcpServiceAccountEmail": { -"description": "The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA.", +"deprecated": true, +"description": "The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring.", "type": "string" }, "oci": { @@ -916,6 +917,28 @@ "description": "State information for ConfigSync.", "id": "ConfigManagementConfigSyncState", "properties": { +"clusterLevelStopSyncingState": { +"description": "Whether syncing resources to the cluster is stopped at the cluster level.", +"enum": [ +"STOP_SYNCING_STATE_UNSPECIFIED", +"NOT_STOPPED", +"PENDING", +"STOPPED" +], +"enumDescriptions": [ +"State cannot be determined", +"Syncing resources to the cluster is not stopped at the cluster level.", +"Some reconcilers stop syncing resources to the cluster, while others are still syncing.", +"Syncing resources to the cluster is stopped at the cluster level." +], +"type": "string" +}, +"crCount": { +"description": "Output only. The number of RootSync and RepoSync CRs in the cluster.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "deploymentState": { "$ref": "ConfigManagementConfigSyncDeploymentState", "description": "Information about the deployment of ConfigSync, including the version. of the various Pods deployed" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json index 074077aa9c..414aa5a2bb 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json @@ -471,7 +471,7 @@ } } }, -"revision": "20241006", +"revision": "20241017", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -714,7 +714,8 @@ "description": "Git repo configuration for the cluster." }, "metricsGcpServiceAccountEmail": { -"description": "The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA.", +"deprecated": true, +"description": "The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring.", "type": "string" }, "oci": { @@ -916,6 +917,28 @@ "description": "State information for ConfigSync.", "id": "ConfigManagementConfigSyncState", "properties": { +"clusterLevelStopSyncingState": { +"description": "Whether syncing resources to the cluster is stopped at the cluster level.", +"enum": [ +"STOP_SYNCING_STATE_UNSPECIFIED", +"NOT_STOPPED", +"PENDING", +"STOPPED" +], +"enumDescriptions": [ +"State cannot be determined", +"Syncing resources to the cluster is not stopped at the cluster level.", +"Some reconcilers stop syncing resources to the cluster, while others are still syncing.", +"Syncing resources to the cluster is stopped at the cluster level." +], +"type": "string" +}, +"crCount": { +"description": "Output only. The number of RootSync and RepoSync CRs in the cluster.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "deploymentState": { "$ref": "ConfigManagementConfigSyncDeploymentState", "description": "Information about the deployment of ConfigSync, including the version. of the various Pods deployed" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json index b4d40d3c1c..1004226e9c 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json @@ -471,7 +471,7 @@ } } }, -"revision": "20241006", +"revision": "20241017", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -714,7 +714,8 @@ "description": "Git repo configuration for the cluster." }, "metricsGcpServiceAccountEmail": { -"description": "The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA.", +"deprecated": true, +"description": "The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. Deprecated: If Workload Identity Federation for GKE is enabled, Google Cloud Service Account is no longer needed for exporting Config Sync metrics: https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-cloud-monitoring#custom-monitoring.", "type": "string" }, "oci": { @@ -916,6 +917,28 @@ "description": "State information for ConfigSync.", "id": "ConfigManagementConfigSyncState", "properties": { +"clusterLevelStopSyncingState": { +"description": "Whether syncing resources to the cluster is stopped at the cluster level.", +"enum": [ +"STOP_SYNCING_STATE_UNSPECIFIED", +"NOT_STOPPED", +"PENDING", +"STOPPED" +], +"enumDescriptions": [ +"State cannot be determined", +"Syncing resources to the cluster is not stopped at the cluster level.", +"Some reconcilers stop syncing resources to the cluster, while others are still syncing.", +"Syncing resources to the cluster is stopped at the cluster level." +], +"type": "string" +}, +"crCount": { +"description": "Output only. The number of RootSync and RepoSync CRs in the cluster.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "deploymentState": { "$ref": "ConfigManagementConfigSyncDeploymentState", "description": "Information about the deployment of ConfigSync, including the version. of the various Pods deployed" diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1.json b/googleapiclient/discovery_cache/documents/healthcare.v1.json index 6235fc99a8..af7f27b262 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json @@ -4783,7 +4783,7 @@ } } }, -"revision": "20240910", +"revision": "20241017", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { @@ -5413,7 +5413,7 @@ "description": "The configuration to use when de-identifying resources that are added to this store." }, "store": { -"description": "The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.", +"description": "Optional. The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.", "type": "string" } }, @@ -5982,7 +5982,7 @@ "id": "FhirStore", "properties": { "complexDataTypeReferenceParsing": { -"description": "Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.", +"description": "Optional. Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.", "enum": [ "COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED", "DISABLED", @@ -6043,7 +6043,7 @@ }, "validationConfig": { "$ref": "ValidationConfig", -"description": "Configuration for how to validate incoming FHIR resources against configured profiles." +"description": "Optional. Configuration for how to validate incoming FHIR resources against configured profiles." }, "version": { "description": "Required. Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store.", @@ -6262,15 +6262,15 @@ "id": "GoogleCloudHealthcareV1DicomBigQueryDestination", "properties": { "force": { -"description": "Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.", +"description": "Optional. Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.", "type": "boolean" }, "tableUri": { -"description": "BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId`", +"description": "Optional. BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId`", "type": "string" }, "writeDisposition": { -"description": "Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored.", +"description": "Optional. Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored.", "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_EMPTY", @@ -7185,7 +7185,7 @@ "description": "Optional. Schemas used to parse messages in this store, if schematized parsing is desired." }, "segmentTerminator": { -"description": "Byte(s) to use as the segment terminator. If this is unset, '\\r' is used as segment terminator, matching the HL7 version 2 specification.", +"description": "Optional. Byte(s) to use as the segment terminator. If this is unset, '\\r' is used as segment terminator, matching the HL7 version 2 specification.", "format": "byte", "type": "string" }, @@ -7889,7 +7889,7 @@ }, "deidentifiedStoreDestination": { "$ref": "DeidentifiedStoreDestination", -"description": "The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging))." +"description": "The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Resources deleted from the source store will be deleted from the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging))." }, "resourceTypes": { "description": "Optional. Supply a FHIR resource type (such as \"Patient\" or \"Observation\"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store.", @@ -8135,23 +8135,23 @@ "id": "ValidationConfig", "properties": { "disableFhirpathValidation": { -"description": "Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", +"description": "Optional. Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "disableProfileValidation": { -"description": "Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store.", +"description": "Optional. Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store.", "type": "boolean" }, "disableReferenceTypeValidation": { -"description": "Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", +"description": "Optional. Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "disableRequiredFieldValidation": { -"description": "Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", +"description": "Optional. Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "enabledImplementationGuides": { -"description": "A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `[\"http://hl7.org/fhir/us/core/ImplementationGuide/ig\"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using \"value\" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error.", +"description": "Optional. A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `[\"http://hl7.org/fhir/us/core/ImplementationGuide/ig\"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using \"value\" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json index fe9d7d789d..2fac3fc70e 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json @@ -5858,7 +5858,7 @@ } } }, -"revision": "20240822", +"revision": "20241009", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -10246,7 +10246,7 @@ }, "deidentifiedStoreDestination": { "$ref": "DeidentifiedStoreDestination", -"description": "The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging))." +"description": "The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Resources deleted from the source store will be deleted from the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging))." }, "resourceTypes": { "description": "Supply a FHIR resource type (such as \"Patient\" or \"Observation\"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store.", diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json index d0e1675e26..a6c4c1960e 100644 --- a/googleapiclient/discovery_cache/documents/iam.v1.json +++ b/googleapiclient/discovery_cache/documents/iam.v1.json @@ -3188,7 +3188,7 @@ } } }, -"revision": "20240918", +"revision": "20241017", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -4280,7 +4280,7 @@ "type": "string" }, "description": { -"description": "A brief description of what this Permission is used for. This permission can ONLY be used in predefined roles.", +"description": "A brief description of what this Permission is used for.", "type": "string" }, "name": { diff --git a/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json b/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json index 948b1242b2..d0acc1f6d8 100644 --- a/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json +++ b/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json @@ -1239,7 +1239,7 @@ } } }, -"revision": "20240621", +"revision": "20241017", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitV1Argon2Parameters": { @@ -2448,6 +2448,26 @@ true "$ref": "GoogleCloudIdentitytoolkitV1AutoRetrievalInfo", "description": "Android only. Used by Google Play Services to identify the app for auto-retrieval." }, +"captchaResponse": { +"description": "Optional. The reCAPTCHA Enterprise token provided by the reCAPTCHA client-side integration. Required when reCAPTCHA enterprise is enabled.", +"type": "string" +}, +"clientType": { +"description": "Optional. The client type, web, android or ios. Required when reCAPTCHA Enterprise is enabled.", +"enum": [ +"CLIENT_TYPE_UNSPECIFIED", +"CLIENT_TYPE_WEB", +"CLIENT_TYPE_ANDROID", +"CLIENT_TYPE_IOS" +], +"enumDescriptions": [ +"Client type is not specified.", +"Client type is web.", +"Client type is android.", +"Client type is ios." +], +"type": "string" +}, "iosReceipt": { "description": "Receipt of successful iOS app token validation. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator. This should come from the response of verifyIosClient. If present, the caller should also provide the `ios_secret`, as well as a bundle ID in the `x-ios-bundle-identifier` header, which must match the bundle ID from the verifyIosClient request.", "type": "string" @@ -2468,6 +2488,18 @@ true "description": "Recaptcha token for app verification. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator. The recaptcha should be generated by calling getRecaptchaParams and the recaptcha token will be generated on user completion of the recaptcha challenge.", "type": "string" }, +"recaptchaVersion": { +"description": "Optional. The reCAPTCHA version of the reCAPTCHA token in the captcha_response.", +"enum": [ +"RECAPTCHA_VERSION_UNSPECIFIED", +"RECAPTCHA_ENTERPRISE" +], +"enumDescriptions": [ +"The reCAPTCHA version is not specified.", +"The reCAPTCHA enterprise." +], +"type": "string" +}, "safetyNetToken": { "description": "Android only. Used to assert application identity in place of a recaptcha token. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator. A SafetyNet Token can be generated via the [SafetyNet Android Attestation API](https://developer.android.com/training/safetynet/attestation.html), with the Base64 encoding of the `phone_number` field as the nonce.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json b/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json index 4b4e557e34..5ddba9045d 100644 --- a/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json +++ b/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json @@ -1655,7 +1655,7 @@ } } }, -"revision": "20240621", +"revision": "20241017", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitAdminV2AllowByDefault": { @@ -2638,6 +2638,22 @@ }, "type": "array" }, +"phoneEnforcementState": { +"description": "The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all related user flows protected by reCAPTCHA.", +"enum": [ +"RECAPTCHA_PROVIDER_ENFORCEMENT_STATE_UNSPECIFIED", +"OFF", +"AUDIT", +"ENFORCE" +], +"enumDescriptions": [ +"Enforcement state has not been set.", +"Unenforced.", +"reCAPTCHA assessment is created, result is not used to enforce.", +"reCAPTCHA assessment is created, result is used to enforce." +], +"type": "string" +}, "recaptchaKeys": { "description": "The reCAPTCHA keys.", "items": { @@ -2645,6 +2661,13 @@ }, "type": "array" }, +"tollFraudManagedRules": { +"description": "The managed rules for toll fraud provider, containing the enforcement status. The toll fraud provider contains all SMS related user flows.", +"items": { +"$ref": "GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule" +}, +"type": "array" +}, "useAccountDefender": { "description": "Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`.", "type": "boolean" @@ -2703,6 +2726,30 @@ }, "type": "object" }, +"GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule": { +"description": "The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The start_score is maximum_allowed_score. End score is 1.0.", +"id": "GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule", +"properties": { +"action": { +"description": "The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].", +"enum": [ +"RECAPTCHA_ACTION_UNSPECIFIED", +"BLOCK" +], +"enumDescriptions": [ +"The reCAPTCHA action is not specified.", +"The reCAPTCHA-protected request will be blocked." +], +"type": "string" +}, +"startScore": { +"description": "The start score (inclusive) for an action. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudIdentitytoolkitAdminV2RequestLogging": { "description": "Configuration for logging requests made to this project to Stackdriver Logging", "id": "GoogleCloudIdentitytoolkitAdminV2RequestLogging", @@ -3350,11 +3397,13 @@ "description": "The provider that has reCAPTCHA protection.", "enum": [ "RECAPTCHA_PROVIDER_UNSPECIFIED", -"EMAIL_PASSWORD_PROVIDER" +"EMAIL_PASSWORD_PROVIDER", +"PHONE_PROVIDER" ], "enumDescriptions": [ "reCAPTCHA provider not specified", -"Email password provider" +"Email password provider", +"Phone auth provider" ], "type": "string" } @@ -3456,6 +3505,26 @@ "$ref": "GoogleCloudIdentitytoolkitV2AutoRetrievalInfo", "description": "Android only. Used by Google Play Services to identify the app for auto-retrieval." }, +"captchaResponse": { +"description": "The reCAPTCHA Enterprise token provided by the reCAPTCHA client-side integration. Required when reCAPTCHA enterprise is enabled.", +"type": "string" +}, +"clientType": { +"description": "The client type, web, android or ios. Required when reCAPTCHA Enterprise is enabled.", +"enum": [ +"CLIENT_TYPE_UNSPECIFIED", +"CLIENT_TYPE_WEB", +"CLIENT_TYPE_ANDROID", +"CLIENT_TYPE_IOS" +], +"enumDescriptions": [ +"Client type is not specified.", +"Client type is web.", +"Client type is android.", +"Client type is ios." +], +"type": "string" +}, "iosReceipt": { "description": "iOS only. Receipt of successful app token validation with APNS.", "type": "string" @@ -3476,6 +3545,18 @@ "description": "Web only. Recaptcha solution.", "type": "string" }, +"recaptchaVersion": { +"description": "The reCAPTCHA version of the reCAPTCHA token in the captcha_response.", +"enum": [ +"RECAPTCHA_VERSION_UNSPECIFIED", +"RECAPTCHA_ENTERPRISE" +], +"enumDescriptions": [ +"The reCAPTCHA version is not specified.", +"The reCAPTCHA enterprise." +], +"type": "string" +}, "safetyNetToken": { "description": "Android only. Used to assert application identity in place of a recaptcha token. A SafetyNet Token can be generated via the [SafetyNet Android Attestation API](https://developer.android.com/training/safetynet/attestation.html), with the Base64 encoding of the `phone_number` field as the nonce.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/integrations.v1.json b/googleapiclient/discovery_cache/documents/integrations.v1.json index c17eafdb43..257c7b2ab6 100644 --- a/googleapiclient/discovery_cache/documents/integrations.v1.json +++ b/googleapiclient/discovery_cache/documents/integrations.v1.json @@ -4497,7 +4497,7 @@ } } }, -"revision": "20241003", +"revision": "20241020", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { @@ -8869,11 +8869,8 @@ false "type": "string" }, "inputVariables": { -"description": "Optional. List of input variables for the api trigger.", -"items": { -"type": "string" -}, -"type": "array" +"$ref": "EnterpriseCrmFrontendsEventbusProtoTriggerConfigVariables", +"description": "Optional. List of input variables for the api trigger." }, "label": { "description": "The user created label for a particular trigger.", @@ -8894,11 +8891,8 @@ false "type": "string" }, "outputVariables": { -"description": "Optional. List of output variables for the api trigger.", -"items": { -"type": "string" -}, -"type": "array" +"$ref": "EnterpriseCrmFrontendsEventbusProtoTriggerConfigVariables", +"description": "Optional. List of output variables for the api trigger." }, "pauseWorkflowExecutions": { "description": "Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.", @@ -8978,6 +8972,20 @@ false }, "type": "object" }, +"EnterpriseCrmFrontendsEventbusProtoTriggerConfigVariables": { +"description": "Variables names mapped to api trigger.", +"id": "EnterpriseCrmFrontendsEventbusProtoTriggerConfigVariables", +"properties": { +"names": { +"description": "Optional. List of variable names.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry": { "id": "EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry", "properties": { @@ -14037,11 +14045,8 @@ false "type": "string" }, "inputVariables": { -"description": "Optional. List of input variables for the api trigger.", -"items": { -"type": "string" -}, -"type": "array" +"$ref": "GoogleCloudIntegrationsV1alphaTriggerConfigVariables", +"description": "Optional. List of input variables for the api trigger." }, "label": { "description": "Optional. The user created label for a particular trigger.", @@ -14062,11 +14067,8 @@ false "type": "string" }, "outputVariables": { -"description": "Optional. List of output variables for the api trigger.", -"items": { -"type": "string" -}, -"type": "array" +"$ref": "GoogleCloudIntegrationsV1alphaTriggerConfigVariables", +"description": "Optional. List of output variables for the api trigger." }, "position": { "$ref": "GoogleCloudIntegrationsV1alphaCoordinate", @@ -14129,6 +14131,20 @@ false }, "type": "object" }, +"GoogleCloudIntegrationsV1alphaTriggerConfigVariables": { +"description": "Variables names mapped to api trigger.", +"id": "GoogleCloudIntegrationsV1alphaTriggerConfigVariables", +"properties": { +"names": { +"description": "Optional. List of variable names.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest": { "description": "Request for UnpublishIntegrationVersion.", "id": "GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest", diff --git a/googleapiclient/discovery_cache/documents/logging.v2.json b/googleapiclient/discovery_cache/documents/logging.v2.json index 9cbc3e0714..5a254ca646 100644 --- a/googleapiclient/discovery_cache/documents/logging.v2.json +++ b/googleapiclient/discovery_cache/documents/logging.v2.json @@ -3166,7 +3166,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope", +"description": "Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/logScopes/[^/]+$", "required": true, @@ -5984,7 +5984,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope", +"description": "Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/logScopes/[^/]+$", "required": true, @@ -7786,7 +7786,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope", +"description": "Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/logScopes/[^/]+$", "required": true, @@ -8922,7 +8922,7 @@ } } }, -"revision": "20240913", +"revision": "20241018", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AuditConfig": { @@ -10430,12 +10430,12 @@ "type": "string" }, "name": { -"description": "Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope", +"description": "Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope", "readOnly": true, "type": "string" }, "resourceNames": { -"description": "Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total.", +"description": "Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/looker.v1.json b/googleapiclient/discovery_cache/documents/looker.v1.json index 8face58ee0..42b1012d90 100644 --- a/googleapiclient/discovery_cache/documents/looker.v1.json +++ b/googleapiclient/discovery_cache/documents/looker.v1.json @@ -731,7 +731,7 @@ } } }, -"revision": "20240910", +"revision": "20241016", "rootUrl": "https://looker.googleapis.com/", "schemas": { "AdminSettings": { @@ -1636,22 +1636,22 @@ "id": "TimeOfDay", "properties": { "hours": { -"description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", +"description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, "minutes": { -"description": "Minutes of hour of day. Must be from 0 to 59.", +"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "type": "integer" }, "nanos": { -"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", +"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32", "type": "integer" }, "seconds": { -"description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", +"description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } diff --git a/googleapiclient/discovery_cache/documents/memcache.v1.json b/googleapiclient/discovery_cache/documents/memcache.v1.json index c4a863c4c4..1f563c1504 100644 --- a/googleapiclient/discovery_cache/documents/memcache.v1.json +++ b/googleapiclient/discovery_cache/documents/memcache.v1.json @@ -584,7 +584,7 @@ } } }, -"revision": "20240919", +"revision": "20241010", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -2095,22 +2095,22 @@ "id": "TimeOfDay", "properties": { "hours": { -"description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", +"description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, "minutes": { -"description": "Minutes of hour of day. Must be from 0 to 59.", +"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "type": "integer" }, "nanos": { -"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", +"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32", "type": "integer" }, "seconds": { -"description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", +"description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } diff --git a/googleapiclient/discovery_cache/documents/memcache.v1beta2.json b/googleapiclient/discovery_cache/documents/memcache.v1beta2.json index 9221e96c29..16e7fcaefc 100644 --- a/googleapiclient/discovery_cache/documents/memcache.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/memcache.v1beta2.json @@ -612,7 +612,7 @@ } } }, -"revision": "20240919", +"revision": "20241010", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -2151,22 +2151,22 @@ "id": "TimeOfDay", "properties": { "hours": { -"description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", +"description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, "minutes": { -"description": "Minutes of hour of day. Must be from 0 to 59.", +"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "type": "integer" }, "nanos": { -"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", +"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32", "type": "integer" }, "seconds": { -"description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", +"description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index ef1ec5b76d..66989a4e77 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -265,7 +265,7 @@ "type": "string" }, "updateMask": { -"description": "Required. List of fields being updated.", +"description": "Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `account_name` - `adult_content` - `language_code` - `time_zone`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -391,7 +391,7 @@ "type": "string" }, "updateMask": { -"description": "Required. List of fields being updated.", +"description": "Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `black_owned` - `latino_owned` - `promotions_consent` - `small_business` - `veteran_owned` - `women_owned`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -454,7 +454,7 @@ "type": "string" }, "updateMask": { -"description": "Required. List of fields being updated.", +"description": "Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `address` - `customer_service` - `korean_business_registration_number`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -476,7 +476,7 @@ "emailPreferences": { "methods": { "getEmailPreferences": { -"description": "Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.", +"description": "Returns the email preferences for a Merchant Center account user. This service only permits retrieving and updating email preferences for the authenticated user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.", "flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", "httpMethod": "GET", "id": "merchantapi.accounts.emailPreferences.getEmailPreferences", @@ -517,7 +517,7 @@ "type": "string" }, "updateMask": { -"description": "Required. List of fields being updated.", +"description": "Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `news_and_tips`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -636,7 +636,7 @@ "type": "string" }, "updateMask": { -"description": "Required. List of fields being updated.", +"description": "Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `uri`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1195,7 +1195,7 @@ ] }, "delete": { -"description": "Deletes a Merchant Center account user. Executing this method requires admin access.", +"description": "Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account. Also a user is protected from deletion if it is managed by Business Manager\"", "flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}", "httpMethod": "DELETE", "id": "merchantapi.accounts.users.delete", @@ -1297,7 +1297,7 @@ "type": "string" }, "updateMask": { -"description": "Required. List of fields being updated.", +"description": "Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `access_rights`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1417,7 +1417,7 @@ } } }, -"revision": "20241004", +"revision": "20241023", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Accepted": { @@ -1538,7 +1538,7 @@ "description": "The provider is an [aggregator](https://support.google.com/merchants/answer/188487) for the account. Payload for service type Account Aggregation." }, "provider": { -"description": "Optional. The provider of the service. Format: `accounts/{account}`", +"description": "Required. The provider of the service. Format: `accounts/{account}`", "type": "string" } }, @@ -1747,7 +1747,12 @@ "ClaimHomepageRequest": { "description": "Request message for the `ClaimHomepage` method.", "id": "ClaimHomepageRequest", -"properties": {}, +"properties": { +"overwrite": { +"description": "Optional. When set to `true`, this option removes any existing claim on the requested website and replaces it with a claim from the account that makes the request.", +"type": "boolean" +} +}, "type": "object" }, "CreateAndConfigureAccountRequest": { @@ -2750,6 +2755,11 @@ false }, "type": "array" }, +"expirationTime": { +"description": "The product expiration time.", +"format": "google-datetime", +"type": "string" +}, "managingAccount": { "description": "The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id}`", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json index b7b2ac205c..7f52ff66b2 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json @@ -245,7 +245,7 @@ "type": "string" }, "updateMask": { -"description": "Required. List of fields being updated.", +"description": "Optional. List of fields being updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -295,7 +295,7 @@ } } }, -"revision": "20241001", +"revision": "20241023", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AttributionSettings": { @@ -593,6 +593,11 @@ false }, "type": "array" }, +"expirationTime": { +"description": "The product expiration time.", +"format": "google-datetime", +"type": "string" +}, "managingAccount": { "description": "The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id}`", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json index 994518b1c6..a6efbae8db 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json @@ -321,7 +321,7 @@ } } }, -"revision": "20241004", +"revision": "20241022", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { @@ -365,6 +365,10 @@ "$ref": "LocalInventoryDataSource", "description": "Required. The [local inventory](https://support.google.com/merchants/answer/7023001) data source." }, +"merchantReviewDataSource": { +"$ref": "MerchantReviewDataSource", +"description": "Required. The [merchant review](https://support.google.com/merchants/answer/7045996) data source." +}, "name": { "description": "Identifier. The name of the data source. Format: `{datasource.name=accounts/{account}/dataSources/{datasource}}`", "type": "string" @@ -373,6 +377,10 @@ "$ref": "PrimaryProductDataSource", "description": "Required. The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products." }, +"productReviewDataSource": { +"$ref": "ProductReviewDataSource", +"description": "Required. The [product review](https://support.google.com/merchants/answer/7045996) data source." +}, "promotionDataSource": { "$ref": "PromotionDataSource", "description": "Required. The [promotion](https://support.google.com/merchants/answer/2906014) data source." @@ -688,6 +696,12 @@ }, "type": "object" }, +"MerchantReviewDataSource": { +"description": "The merchant review data source.", +"id": "MerchantReviewDataSource", +"properties": {}, +"type": "object" +}, "PrimaryProductDataSource": { "description": "The primary data source for local and online products.", "id": "PrimaryProductDataSource", @@ -810,6 +824,12 @@ false }, "type": "object" }, +"ProductReviewDataSource": { +"description": "The product review data source.", +"id": "ProductReviewDataSource", +"properties": {}, +"type": "object" +}, "ProductStatusChangeMessage": { "description": "The message that the merchant will receive to notify about product status change event", "id": "ProductStatusChangeMessage", @@ -837,6 +857,11 @@ false }, "type": "array" }, +"expirationTime": { +"description": "The product expiration time.", +"format": "google-datetime", +"type": "string" +}, "managingAccount": { "description": "The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id}`", "type": "string" @@ -903,7 +928,7 @@ false "type": "string" }, "feedLabel": { -"description": "Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.", +"description": "Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.", "type": "string" }, "referencingPrimaryDataSources": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json index dad77220ef..f3d82ac836 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json @@ -300,7 +300,7 @@ } } }, -"revision": "20240827", +"revision": "20241022", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CustomAttribute": { @@ -569,6 +569,11 @@ false }, "type": "array" }, +"expirationTime": { +"description": "The product expiration time.", +"format": "google-datetime", +"type": "string" +}, "managingAccount": { "description": "The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id}`", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json index 1d9e0b4460..7c44a294fd 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json @@ -298,7 +298,7 @@ } } }, -"revision": "20240827", +"revision": "20241023", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -643,6 +643,11 @@ false }, "type": "array" }, +"expirationTime": { +"description": "The product expiration time.", +"format": "google-datetime", +"type": "string" +}, "managingAccount": { "description": "The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id}`", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json index 45378a5f7e..9b5347ecbb 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json @@ -262,7 +262,7 @@ } } }, -"revision": "20240930", +"revision": "20241022", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -432,6 +432,11 @@ false }, "type": "array" }, +"expirationTime": { +"description": "The product expiration time.", +"format": "google-datetime", +"type": "string" +}, "managingAccount": { "description": "The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id}`", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json index 1aa53df380..26adb94c4a 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json @@ -124,7 +124,7 @@ "type": "string" }, "name": { -"description": "Required. The name of the product input resource to delete. Format: accounts/{account}/productInputs/{product}", +"description": "Required. The name of the product input resource to delete. Format: accounts/{account}/productInputs/{product} where the last section `product` consists of 4 parts: channel~content_language~feed_label~offer_id example for product name is \"accounts/123/productInputs/online~en~US~sku123\"", "location": "path", "pattern": "^accounts/[^/]+/productInputs/[^/]+$", "required": true, @@ -186,7 +186,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the product to retrieve. Format: `accounts/{account}/products/{product}`", +"description": "Required. The name of the product to retrieve. Format: `accounts/{account}/products/{product}` where the last section `product` consists of 4 parts: channel~content_language~feed_label~offer_id example for product name is \"accounts/123/products/online~en~US~sku123\"", "location": "path", "pattern": "^accounts/[^/]+/products/[^/]+$", "required": true, @@ -242,7 +242,7 @@ } } }, -"revision": "20241001", +"revision": "20241022", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -1441,6 +1441,11 @@ false }, "type": "array" }, +"expirationTime": { +"description": "The product expiration time.", +"format": "google-datetime", +"type": "string" +}, "managingAccount": { "description": "The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id}`", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json index 4f1889a437..ec04f26a86 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json @@ -203,7 +203,7 @@ } } }, -"revision": "20241004", +"revision": "20241022", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -390,7 +390,13 @@ "LOCAL_INVENTORY_ADS", "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", -"YOUTUBE_SHOPPING" +"YOUTUBE_SHOPPING", +"YOUTUBE_SHOPPING_CHECKOUT", +"YOUTUBE_AFFILIATE", +"FREE_VEHICLE_LISTINGS", +"VEHICLE_ADS", +"CLOUD_RETAIL", +"LOCAL_CLOUD_RETAIL" ], "enumDescriptions": [ "Not specified.", @@ -399,7 +405,13 @@ "[Local inventory ads](https://support.google.com/merchants/answer/3057972).", "[Free listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", -"[YouTube Shopping](https://support.google.com/merchants/answer/12362804)." +"[YouTube Shopping](https://support.google.com/merchants/answer/12362804).", +"Youtube shopping checkout.", +"Youtube affiliate.", +"Free vehicle listings.", +"Vehicle ads.", +"Cloud retail.", +"Local cloud retail." ], "type": "string" }, @@ -859,6 +871,11 @@ false }, "type": "array" }, +"expirationTime": { +"description": "The product expiration time.", +"format": "google-datetime", +"type": "string" +}, "managingAccount": { "description": "The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id}`", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json index 720760513d..f34a85456a 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json @@ -150,7 +150,7 @@ } } }, -"revision": "20240827", +"revision": "20241022", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "ListQuotaGroupsResponse": { @@ -305,6 +305,11 @@ false }, "type": "array" }, +"expirationTime": { +"description": "The product expiration time.", +"format": "google-datetime", +"type": "string" +}, "managingAccount": { "description": "The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id}`", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json index 900727103c..af887e24ed 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json @@ -142,7 +142,7 @@ } } }, -"revision": "20240827", +"revision": "20241022", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "BestSellersBrandView": { @@ -1237,6 +1237,11 @@ false }, "type": "array" }, +"expirationTime": { +"description": "The product expiration time.", +"format": "google-datetime", +"type": "string" +}, "managingAccount": { "description": "The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id}`", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json new file mode 100644 index 0000000000..feead767f0 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json @@ -0,0 +1,1357 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/content": { +"description": "Manage your product listings and accounts for Google Shopping" +} +} +} +}, +"basePath": "", +"baseUrl": "https://merchantapi.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Merchant", +"description": "Programmatically manage your Merchant Center Accounts.", +"discoveryVersion": "v1", +"documentationLink": "https://developers.devsite.corp.google.com/merchant/api", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "merchantapi:reviews_v1beta", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://merchantapi.mtls.googleapis.com/", +"name": "merchantapi", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"accounts": { +"resources": { +"merchantReviews": { +"methods": { +"delete": { +"description": "Deletes merchant review.", +"flatPath": "reviews/v1beta/accounts/{accountsId}/merchantReviews/{merchantReviewsId}", +"httpMethod": "DELETE", +"id": "merchantapi.accounts.merchantReviews.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The ID of the merchant review. Format: accounts/{account}/merchantReviews/{merchantReview}", +"location": "path", +"pattern": "^accounts/[^/]+/merchantReviews/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "reviews/v1beta/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +}, +"get": { +"description": "Gets a merchant review.", +"flatPath": "reviews/v1beta/accounts/{accountsId}/merchantReviews/{merchantReviewsId}", +"httpMethod": "GET", +"id": "merchantapi.accounts.merchantReviews.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The ID of the merchant review. Format: accounts/{account}/merchantReviews/{merchantReview}", +"location": "path", +"pattern": "^accounts/[^/]+/merchantReviews/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "reviews/v1beta/{+name}", +"response": { +"$ref": "MerchantReview" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +}, +"insert": { +"description": "Inserts a review for your Merchant Center account. If the review already exists, then the review is replaced with the new instance.", +"flatPath": "reviews/v1beta/accounts/{accountsId}/merchantReviews:insert", +"httpMethod": "POST", +"id": "merchantapi.accounts.merchantReviews.insert", +"parameterOrder": [ +"parent" +], +"parameters": { +"dataSource": { +"description": "Required. The data source of the [merchantreview](https://support.google.com/merchants/answer/7045996?sjid=5253581244217581976-EU) Format: `accounts/{account}/dataSources/{datasource}`.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The account where the merchant review will be inserted. Format: accounts/{account}", +"location": "path", +"pattern": "^accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "reviews/v1beta/{+parent}/merchantReviews:insert", +"request": { +"$ref": "MerchantReview" +}, +"response": { +"$ref": "MerchantReview" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +}, +"list": { +"description": "Lists merchant reviews.", +"flatPath": "reviews/v1beta/accounts/{accountsId}/merchantReviews", +"httpMethod": "GET", +"id": "merchantapi.accounts.merchantReviews.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of merchant reviews to return. The service can return fewer than this value. The maximum value is 1000; values above 1000 are coerced to 1000. If unspecified, the maximum number of reviews is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListMerchantReviews` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMerchantReviews` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The account to list merchant reviews for. Format: accounts/{account}", +"location": "path", +"pattern": "^accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "reviews/v1beta/{+parent}/merchantReviews", +"response": { +"$ref": "ListMerchantReviewsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +} +} +}, +"productReviews": { +"methods": { +"delete": { +"description": "Deletes a product review.", +"flatPath": "reviews/v1beta/accounts/{accountsId}/productReviews/{productReviewsId}", +"httpMethod": "DELETE", +"id": "merchantapi.accounts.productReviews.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The ID of the Product review. Format: accounts/{account}/productReviews/{productReview}", +"location": "path", +"pattern": "^accounts/[^/]+/productReviews/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "reviews/v1beta/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +}, +"get": { +"description": "Gets a product review.", +"flatPath": "reviews/v1beta/accounts/{accountsId}/productReviews/{productReviewsId}", +"httpMethod": "GET", +"id": "merchantapi.accounts.productReviews.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The ID of the merchant review. Format: accounts/{account}/productReviews/{productReview}", +"location": "path", +"pattern": "^accounts/[^/]+/productReviews/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "reviews/v1beta/{+name}", +"response": { +"$ref": "ProductReview" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +}, +"insert": { +"description": "Inserts a product review.", +"flatPath": "reviews/v1beta/accounts/{accountsId}/productReviews:insert", +"httpMethod": "POST", +"id": "merchantapi.accounts.productReviews.insert", +"parameterOrder": [ +"parent" +], +"parameters": { +"dataSource": { +"description": "Required. Format: `accounts/{account}/dataSources/{datasource}`.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The account where the product review will be inserted. Format: accounts/{account}", +"location": "path", +"pattern": "^accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "reviews/v1beta/{+parent}/productReviews:insert", +"request": { +"$ref": "ProductReview" +}, +"response": { +"$ref": "ProductReview" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +}, +"list": { +"description": "Lists product reviews.", +"flatPath": "reviews/v1beta/accounts/{accountsId}/productReviews", +"httpMethod": "GET", +"id": "merchantapi.accounts.productReviews.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of products to return. The service may return fewer than this value.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListProductReviews` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProductReviews` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The account to list product reviews for. Format: accounts/{account}", +"location": "path", +"pattern": "^accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "reviews/v1beta/{+parent}/productReviews", +"response": { +"$ref": "ListProductReviewsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +} +} +} +} +} +}, +"revision": "20241022", +"rootUrl": "https://merchantapi.googleapis.com/", +"schemas": { +"CustomAttribute": { +"description": "A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.", +"id": "CustomAttribute", +"properties": { +"groupValues": { +"description": "Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.", +"items": { +"$ref": "CustomAttribute" +}, +"type": "array" +}, +"name": { +"description": "The name of the attribute.", +"type": "string" +}, +"value": { +"description": "The value of the attribute. If `value` is not empty, `group_values` must be empty.", +"type": "string" +} +}, +"type": "object" +}, +"Empty": { +"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", +"id": "Empty", +"properties": {}, +"type": "object" +}, +"ListMerchantReviewsResponse": { +"description": "Response message for the `ListMerchantsReview` method.", +"id": "ListMerchantReviewsResponse", +"properties": { +"merchantReviews": { +"description": "The merchant review.", +"items": { +"$ref": "MerchantReview" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The token to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListProductReviewsResponse": { +"description": "response message for the ListProductReviews method.", +"id": "ListProductReviewsResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"productReviews": { +"description": "The product review.", +"items": { +"$ref": "ProductReview" +}, +"type": "array" +} +}, +"type": "object" +}, +"MerchantReview": { +"description": "A review for a merchant. For more information, see [Introduction to Merchant Review Feeds](https://developers.google.com/merchant-review-feeds)", +"id": "MerchantReview", +"properties": { +"attributes": { +"$ref": "MerchantReviewAttributes", +"description": "Optional. A list of merchant review attributes." +}, +"customAttributes": { +"description": "Required. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion.", +"items": { +"$ref": "CustomAttribute" +}, +"type": "array" +}, +"dataSource": { +"description": "Output only. The primary data source of the merchant review.", +"readOnly": true, +"type": "string" +}, +"merchantReviewId": { +"description": "Required. The user provided merchant review ID to uniquely identify the merchant review.", +"type": "string" +}, +"merchantReviewStatus": { +"$ref": "MerchantReviewStatus", +"description": "Output only. The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously.", +"readOnly": true +}, +"name": { +"description": "Identifier. The name of the merchant review. Format: `\"{merchantreview.name=accounts/{account}/merchantReviews/{merchantReview}}\"`", +"type": "string" +} +}, +"type": "object" +}, +"MerchantReviewAttributes": { +"description": "Attributes.", +"id": "MerchantReviewAttributes", +"properties": { +"collectionMethod": { +"description": "Optional. The method used to collect the review.", +"enum": [ +"COLLECTION_METHOD_UNSPECIFIED", +"MERCHANT_UNSOLICITED", +"POINT_OF_SALE", +"AFTER_FULFILLMENT" +], +"enumDescriptions": [ +"Collection method unspecified.", +"The user was not responding to a specific solicitation when they submitted the review.", +"The user submitted the review in response to a solicitation when the user placed an order.", +"The user submitted the review in response to a solicitation after fulfillment of the user's order." +], +"type": "string" +}, +"content": { +"description": "Required. This should be any freeform text provided by the user and should not be truncated. If multiple responses to different questions are provided, all responses should be included, with the minimal context for the responses to make sense. Context should not be provided if questions were left unanswered.", +"type": "string" +}, +"isAnonymous": { +"description": "Optional. Set to true if the reviewer should remain anonymous.", +"type": "boolean" +}, +"maxRating": { +"description": "Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min rating.", +"format": "int64", +"type": "string" +}, +"merchantDisplayName": { +"description": "Optional. Human-readable display name for the merchant.", +"type": "string" +}, +"merchantId": { +"description": "Required. Must be unique and stable across all requests. In other words, if a request today and another 90 days ago refer to the same merchant, they must have the same id.", +"type": "string" +}, +"merchantLink": { +"description": "Optional. URL to the merchant's main website. Do not use a redirect URL for this value. In other words, the value should point directly to the merchant's site.", +"type": "string" +}, +"merchantRatingLink": { +"description": "Optional. URL to the landing page that hosts the reviews for this merchant. Do not use a redirect URL.", +"type": "string" +}, +"minRating": { +"description": "Optional. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.", +"format": "int64", +"type": "string" +}, +"rating": { +"description": "Optional. The reviewer's overall rating of the merchant.", +"format": "double", +"type": "number" +}, +"reviewCountry": { +"description": "Optional. The country where the reviewer made the order defined by ISO 3166-1 Alpha-2 Country Code.", +"type": "string" +}, +"reviewLanguage": { +"description": "Required. The language of the review defined by BCP-47 language code.", +"type": "string" +}, +"reviewTime": { +"description": "Required. The timestamp indicating when the review was written.", +"format": "google-datetime", +"type": "string" +}, +"reviewerId": { +"description": "Optional. A permanent, unique identifier for the author of the review in the publisher's system.", +"type": "string" +}, +"reviewerUsername": { +"description": "Optional. Display name of the review author.", +"type": "string" +}, +"title": { +"description": "Optional. The title of the review.", +"type": "string" +} +}, +"type": "object" +}, +"MerchantReviewDestinationStatus": { +"description": "The destination status of the merchant review status.", +"id": "MerchantReviewDestinationStatus", +"properties": { +"reportingContext": { +"description": "Output only. The name of the reporting context.", +"enum": [ +"REPORTING_CONTEXT_ENUM_UNSPECIFIED", +"SHOPPING_ADS", +"DISCOVERY_ADS", +"DEMAND_GEN_ADS", +"DEMAND_GEN_ADS_DISCOVER_SURFACE", +"VIDEO_ADS", +"DISPLAY_ADS", +"LOCAL_INVENTORY_ADS", +"VEHICLE_INVENTORY_ADS", +"FREE_LISTINGS", +"FREE_LOCAL_LISTINGS", +"FREE_LOCAL_VEHICLE_LISTINGS", +"YOUTUBE_SHOPPING", +"CLOUD_RETAIL", +"LOCAL_CLOUD_RETAIL", +"PRODUCT_REVIEWS", +"MERCHANT_REVIEWS" +], +"enumDeprecated": [ +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Not specified.", +"[Shopping ads](https://support.google.com/merchants/answer/6149970).", +"Deprecated: Use `DEMAND_GEN_ADS` instead. [Discovery and Demand Gen ads](https://support.google.com/merchants/answer/13389785).", +"[Demand Gen ads](https://support.google.com/merchants/answer/13389785).", +"[Demand Gen ads on Discover surface](https://support.google.com/merchants/answer/13389785).", +"[Video ads](https://support.google.com/google-ads/answer/6340491).", +"[Display ads](https://support.google.com/merchants/answer/6069387).", +"[Local inventory ads](https://support.google.com/merchants/answer/3271956).", +"[Vehicle inventory ads](https://support.google.com/merchants/answer/11544533).", +"[Free product listings](https://support.google.com/merchants/answer/9199328).", +"[Free local product listings](https://support.google.com/merchants/answer/9825611).", +"[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", +"[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", +"[Cloud retail](https://cloud.google.com/solutions/retail).", +"[Local cloud retail](https://cloud.google.com/solutions/retail).", +"[Product Reviews](https://support.google.com/merchants/answer/14620732).", +"[Merchant Reviews](https://developers.google.com/merchant-review-feeds)." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"MerchantReviewItemLevelIssue": { +"description": "The ItemLevelIssue of the merchant review status.", +"id": "MerchantReviewItemLevelIssue", +"properties": { +"attribute": { +"description": "Output only. The attribute's name, if the issue is caused by a single attribute.", +"readOnly": true, +"type": "string" +}, +"code": { +"description": "Output only. The error code of the issue.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Output only. A short issue description in English.", +"readOnly": true, +"type": "string" +}, +"detail": { +"description": "Output only. A detailed issue description in English.", +"readOnly": true, +"type": "string" +}, +"documentation": { +"description": "Output only. The URL of a web page to help with resolving this issue.", +"readOnly": true, +"type": "string" +}, +"reportingContext": { +"description": "Output only. The reporting context the issue applies to.", +"enum": [ +"REPORTING_CONTEXT_ENUM_UNSPECIFIED", +"SHOPPING_ADS", +"DISCOVERY_ADS", +"DEMAND_GEN_ADS", +"DEMAND_GEN_ADS_DISCOVER_SURFACE", +"VIDEO_ADS", +"DISPLAY_ADS", +"LOCAL_INVENTORY_ADS", +"VEHICLE_INVENTORY_ADS", +"FREE_LISTINGS", +"FREE_LOCAL_LISTINGS", +"FREE_LOCAL_VEHICLE_LISTINGS", +"YOUTUBE_SHOPPING", +"CLOUD_RETAIL", +"LOCAL_CLOUD_RETAIL", +"PRODUCT_REVIEWS", +"MERCHANT_REVIEWS" +], +"enumDeprecated": [ +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Not specified.", +"[Shopping ads](https://support.google.com/merchants/answer/6149970).", +"Deprecated: Use `DEMAND_GEN_ADS` instead. [Discovery and Demand Gen ads](https://support.google.com/merchants/answer/13389785).", +"[Demand Gen ads](https://support.google.com/merchants/answer/13389785).", +"[Demand Gen ads on Discover surface](https://support.google.com/merchants/answer/13389785).", +"[Video ads](https://support.google.com/google-ads/answer/6340491).", +"[Display ads](https://support.google.com/merchants/answer/6069387).", +"[Local inventory ads](https://support.google.com/merchants/answer/3271956).", +"[Vehicle inventory ads](https://support.google.com/merchants/answer/11544533).", +"[Free product listings](https://support.google.com/merchants/answer/9199328).", +"[Free local product listings](https://support.google.com/merchants/answer/9825611).", +"[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", +"[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", +"[Cloud retail](https://cloud.google.com/solutions/retail).", +"[Local cloud retail](https://cloud.google.com/solutions/retail).", +"[Product Reviews](https://support.google.com/merchants/answer/14620732).", +"[Merchant Reviews](https://developers.google.com/merchant-review-feeds)." +], +"readOnly": true, +"type": "string" +}, +"resolution": { +"description": "Output only. Whether the issue can be resolved by the merchant.", +"readOnly": true, +"type": "string" +}, +"severity": { +"description": "Output only. How this issue affects serving of the merchant review.", +"enum": [ +"SEVERITY_UNSPECIFIED", +"NOT_IMPACTED", +"DISAPPROVED" +], +"enumDescriptions": [ +"Not specified.", +"This issue represents a warning and does not have a direct affect on the merchant review.", +"Issue disapproves the merchant review." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"MerchantReviewStatus": { +"description": "The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously.", +"id": "MerchantReviewStatus", +"properties": { +"createTime": { +"description": "Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"destinationStatuses": { +"description": "Output only. The intended destinations for the merchant review.", +"items": { +"$ref": "MerchantReviewDestinationStatus" +}, +"readOnly": true, +"type": "array" +}, +"itemLevelIssues": { +"description": "Output only. A list of all issues associated with the merchant review.", +"items": { +"$ref": "MerchantReviewItemLevelIssue" +}, +"readOnly": true, +"type": "array" +}, +"lastUpdateTime": { +"description": "Output only. Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ProductChange": { +"description": "The change that happened to the product including old value, new value, country code as the region code and reporting context.", +"id": "ProductChange", +"properties": { +"newValue": { +"description": "The new value of the changed resource or attribute.", +"type": "string" +}, +"oldValue": { +"description": "The old value of the changed resource or attribute.", +"type": "string" +}, +"regionCode": { +"description": "Countries that have the change (if applicable)", +"type": "string" +}, +"reportingContext": { +"description": "Reporting contexts that have the change (if applicable)", +"enum": [ +"REPORTING_CONTEXT_ENUM_UNSPECIFIED", +"SHOPPING_ADS", +"DISCOVERY_ADS", +"DEMAND_GEN_ADS", +"DEMAND_GEN_ADS_DISCOVER_SURFACE", +"VIDEO_ADS", +"DISPLAY_ADS", +"LOCAL_INVENTORY_ADS", +"VEHICLE_INVENTORY_ADS", +"FREE_LISTINGS", +"FREE_LOCAL_LISTINGS", +"FREE_LOCAL_VEHICLE_LISTINGS", +"YOUTUBE_SHOPPING", +"CLOUD_RETAIL", +"LOCAL_CLOUD_RETAIL", +"PRODUCT_REVIEWS", +"MERCHANT_REVIEWS" +], +"enumDeprecated": [ +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Not specified.", +"[Shopping ads](https://support.google.com/merchants/answer/6149970).", +"Deprecated: Use `DEMAND_GEN_ADS` instead. [Discovery and Demand Gen ads](https://support.google.com/merchants/answer/13389785).", +"[Demand Gen ads](https://support.google.com/merchants/answer/13389785).", +"[Demand Gen ads on Discover surface](https://support.google.com/merchants/answer/13389785).", +"[Video ads](https://support.google.com/google-ads/answer/6340491).", +"[Display ads](https://support.google.com/merchants/answer/6069387).", +"[Local inventory ads](https://support.google.com/merchants/answer/3271956).", +"[Vehicle inventory ads](https://support.google.com/merchants/answer/11544533).", +"[Free product listings](https://support.google.com/merchants/answer/9199328).", +"[Free local product listings](https://support.google.com/merchants/answer/9825611).", +"[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", +"[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", +"[Cloud retail](https://cloud.google.com/solutions/retail).", +"[Local cloud retail](https://cloud.google.com/solutions/retail).", +"[Product Reviews](https://support.google.com/merchants/answer/14620732).", +"[Merchant Reviews](https://developers.google.com/merchant-review-feeds)." +], +"type": "string" +} +}, +"type": "object" +}, +"ProductReview": { +"description": "A review for a product. For more information, see [Introduction to Product Review Feeds](https://developers.google.com/product-review-feeds)", +"id": "ProductReview", +"properties": { +"attributes": { +"$ref": "ProductReviewAttributes", +"description": "Optional. A list of product review attributes." +}, +"customAttributes": { +"description": "Optional. A list of custom (merchant-provided) attributes.", +"items": { +"$ref": "CustomAttribute" +}, +"type": "array" +}, +"dataSource": { +"description": "Output only. The primary data source of the product review.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The name of the product review. Format: `\"{productreview.name=accounts/{account}/productReviews/{productReview}}\"`", +"type": "string" +}, +"productReviewId": { +"description": "Required. The permanent, unique identifier for the product review in the publisher\u2019s system.", +"type": "string" +}, +"productReviewStatus": { +"$ref": "ProductReviewStatus", +"description": "Output only. The status of a product review, data validation issues, that is, information about a product review computed asynchronously.", +"readOnly": true +} +}, +"type": "object" +}, +"ProductReviewAttributes": { +"description": "Attributes.", +"id": "ProductReviewAttributes", +"properties": { +"aggregatorName": { +"description": "Optional. The name of the aggregator of the product reviews. A publisher may use a reviews aggregator to manage reviews and provide the feeds. This element indicates the use of an aggregator and contains information about the aggregator.", +"type": "string" +}, +"asins": { +"description": "Optional. Contains ASINs (Amazon Standard Identification Numbers) associated with a product.", +"items": { +"type": "string" +}, +"type": "array" +}, +"brands": { +"description": "Optional. Contains brand names associated with a product.", +"items": { +"type": "string" +}, +"type": "array" +}, +"collectionMethod": { +"description": "Optional. The method used to collect the review.", +"enum": [ +"COLLECTION_METHOD_UNSPECIFIED", +"UNSOLICITED", +"POST_FULFILLMENT" +], +"enumDescriptions": [ +"Collection method unspecified.", +"The user was not responding to a specific solicitation when they submitted the review.", +"The user submitted the review in response to a solicitation after fulfillment of the user's order." +], +"type": "string" +}, +"cons": { +"description": "Optional. Contains the disadvantages based on the opinion of the reviewer. Omit boilerplate text like \"con:\" unless it was written by the reviewer.", +"items": { +"type": "string" +}, +"type": "array" +}, +"content": { +"description": "Required. The content of the review.", +"type": "string" +}, +"gtins": { +"description": "Optional. Contains GTINs (global trade item numbers) associated with a product. Sub-types of GTINs (e.g. UPC, EAN, ISBN, JAN) are supported.", +"items": { +"type": "string" +}, +"type": "array" +}, +"isSpam": { +"description": "Optional. Indicates whether the review is marked as spam in the publisher's system.", +"type": "boolean" +}, +"maxRating": { +"description": "Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min attribute.", +"format": "int64", +"type": "string" +}, +"minRating": { +"description": "Optional. Contains the ratings associated with the review. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.", +"format": "int64", +"type": "string" +}, +"mpns": { +"description": "Optional. Contains MPNs (manufacturer part numbers) associated with a product.", +"items": { +"type": "string" +}, +"type": "array" +}, +"productLinks": { +"description": "Optional. The URI of the product. This URI can have the same value as the `review_link` element, if the review URI and the product URI are the same.", +"items": { +"type": "string" +}, +"type": "array" +}, +"productNames": { +"description": "Optional. Descriptive name of a product.", +"items": { +"type": "string" +}, +"type": "array" +}, +"pros": { +"description": "Optional. Contains the advantages based on the opinion of the reviewer. Omit boilerplate text like \"pro:\" unless it was written by the reviewer.", +"items": { +"type": "string" +}, +"type": "array" +}, +"publisherFavicon": { +"description": "Optional. A link to the company favicon of the publisher. The image dimensions should be favicon size: 16x16 pixels. The image format should be GIF, JPG or PNG.", +"type": "string" +}, +"publisherName": { +"description": "Optional. The name of the publisher of the product reviews. The information about the publisher, which may be a retailer, manufacturer, reviews service company, or any entity that publishes product reviews.", +"type": "string" +}, +"rating": { +"description": "Optional. The reviewer's overall rating of the product.", +"format": "double", +"type": "number" +}, +"reviewCountry": { +"description": "Optional. The country of the review defined by ISO 3166-1 Alpha-2 Country Code.", +"type": "string" +}, +"reviewLanguage": { +"description": "Optional. The language of the review defined by BCP-47 language code.", +"type": "string" +}, +"reviewLink": { +"$ref": "ReviewLink", +"description": "Optional. The URI of the review landing page." +}, +"reviewTime": { +"description": "Required. The timestamp indicating when the review was written.", +"format": "google-datetime", +"type": "string" +}, +"reviewerId": { +"description": "Optional. The author of the product review. A permanent, unique identifier for the author of the review in the publisher's system.", +"type": "string" +}, +"reviewerImageLinks": { +"description": "Optional. A URI to an image of the reviewed product created by the review author. The URI does not have to end with an image file extension.", +"items": { +"type": "string" +}, +"type": "array" +}, +"reviewerIsAnonymous": { +"description": "Optional. Set to true if the reviewer should remain anonymous.", +"type": "boolean" +}, +"reviewerUsername": { +"description": "Optional. The name of the reviewer of the product review.", +"type": "string" +}, +"skus": { +"description": "Optional. Contains SKUs (stock keeping units) associated with a product. Often this matches the product Offer Id in the product feed.", +"items": { +"type": "string" +}, +"type": "array" +}, +"subclientName": { +"description": "Optional. The name of the subclient of the product reviews. The subclient is an identifier of the product review source. It should be equivalent to the directory provided in the file data source path.", +"type": "string" +}, +"title": { +"description": "Optional. The title of the review.", +"type": "string" +}, +"transactionId": { +"description": "Optional. A permanent, unique identifier for the transaction associated with the review in the publisher's system. This ID can be used to indicate that multiple reviews are associated with the same transaction.", +"type": "string" +} +}, +"type": "object" +}, +"ProductReviewDestinationStatus": { +"description": "The destination status of the product review status.", +"id": "ProductReviewDestinationStatus", +"properties": { +"reportingContext": { +"description": "Output only. The name of the reporting context.", +"enum": [ +"REPORTING_CONTEXT_ENUM_UNSPECIFIED", +"SHOPPING_ADS", +"DISCOVERY_ADS", +"DEMAND_GEN_ADS", +"DEMAND_GEN_ADS_DISCOVER_SURFACE", +"VIDEO_ADS", +"DISPLAY_ADS", +"LOCAL_INVENTORY_ADS", +"VEHICLE_INVENTORY_ADS", +"FREE_LISTINGS", +"FREE_LOCAL_LISTINGS", +"FREE_LOCAL_VEHICLE_LISTINGS", +"YOUTUBE_SHOPPING", +"CLOUD_RETAIL", +"LOCAL_CLOUD_RETAIL", +"PRODUCT_REVIEWS", +"MERCHANT_REVIEWS" +], +"enumDeprecated": [ +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Not specified.", +"[Shopping ads](https://support.google.com/merchants/answer/6149970).", +"Deprecated: Use `DEMAND_GEN_ADS` instead. [Discovery and Demand Gen ads](https://support.google.com/merchants/answer/13389785).", +"[Demand Gen ads](https://support.google.com/merchants/answer/13389785).", +"[Demand Gen ads on Discover surface](https://support.google.com/merchants/answer/13389785).", +"[Video ads](https://support.google.com/google-ads/answer/6340491).", +"[Display ads](https://support.google.com/merchants/answer/6069387).", +"[Local inventory ads](https://support.google.com/merchants/answer/3271956).", +"[Vehicle inventory ads](https://support.google.com/merchants/answer/11544533).", +"[Free product listings](https://support.google.com/merchants/answer/9199328).", +"[Free local product listings](https://support.google.com/merchants/answer/9825611).", +"[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", +"[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", +"[Cloud retail](https://cloud.google.com/solutions/retail).", +"[Local cloud retail](https://cloud.google.com/solutions/retail).", +"[Product Reviews](https://support.google.com/merchants/answer/14620732).", +"[Merchant Reviews](https://developers.google.com/merchant-review-feeds)." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ProductReviewItemLevelIssue": { +"description": "The ItemLevelIssue of the product review status.", +"id": "ProductReviewItemLevelIssue", +"properties": { +"attribute": { +"description": "Output only. The attribute's name, if the issue is caused by a single attribute.", +"readOnly": true, +"type": "string" +}, +"code": { +"description": "Output only. The error code of the issue.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Output only. A short issue description in English.", +"readOnly": true, +"type": "string" +}, +"detail": { +"description": "Output only. A detailed issue description in English.", +"readOnly": true, +"type": "string" +}, +"documentation": { +"description": "Output only. The URL of a web page to help with resolving this issue.", +"readOnly": true, +"type": "string" +}, +"reportingContext": { +"description": "Output only. The reporting context the issue applies to.", +"enum": [ +"REPORTING_CONTEXT_ENUM_UNSPECIFIED", +"SHOPPING_ADS", +"DISCOVERY_ADS", +"DEMAND_GEN_ADS", +"DEMAND_GEN_ADS_DISCOVER_SURFACE", +"VIDEO_ADS", +"DISPLAY_ADS", +"LOCAL_INVENTORY_ADS", +"VEHICLE_INVENTORY_ADS", +"FREE_LISTINGS", +"FREE_LOCAL_LISTINGS", +"FREE_LOCAL_VEHICLE_LISTINGS", +"YOUTUBE_SHOPPING", +"CLOUD_RETAIL", +"LOCAL_CLOUD_RETAIL", +"PRODUCT_REVIEWS", +"MERCHANT_REVIEWS" +], +"enumDeprecated": [ +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Not specified.", +"[Shopping ads](https://support.google.com/merchants/answer/6149970).", +"Deprecated: Use `DEMAND_GEN_ADS` instead. [Discovery and Demand Gen ads](https://support.google.com/merchants/answer/13389785).", +"[Demand Gen ads](https://support.google.com/merchants/answer/13389785).", +"[Demand Gen ads on Discover surface](https://support.google.com/merchants/answer/13389785).", +"[Video ads](https://support.google.com/google-ads/answer/6340491).", +"[Display ads](https://support.google.com/merchants/answer/6069387).", +"[Local inventory ads](https://support.google.com/merchants/answer/3271956).", +"[Vehicle inventory ads](https://support.google.com/merchants/answer/11544533).", +"[Free product listings](https://support.google.com/merchants/answer/9199328).", +"[Free local product listings](https://support.google.com/merchants/answer/9825611).", +"[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", +"[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", +"[Cloud retail](https://cloud.google.com/solutions/retail).", +"[Local cloud retail](https://cloud.google.com/solutions/retail).", +"[Product Reviews](https://support.google.com/merchants/answer/14620732).", +"[Merchant Reviews](https://developers.google.com/merchant-review-feeds)." +], +"readOnly": true, +"type": "string" +}, +"resolution": { +"description": "Output only. Whether the issue can be resolved by the merchant.", +"readOnly": true, +"type": "string" +}, +"severity": { +"description": "Output only. How this issue affects serving of the product review.", +"enum": [ +"SEVERITY_UNSPECIFIED", +"NOT_IMPACTED", +"DISAPPROVED" +], +"enumDescriptions": [ +"Not specified.", +"This issue represents a warning and does not have a direct affect on the product review.", +"Issue disapproves the product review." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ProductReviewStatus": { +"description": "Product review status.", +"id": "ProductReviewStatus", +"properties": { +"createTime": { +"description": "Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"destinationStatuses": { +"description": "Output only. The intended destinations for the product review.", +"items": { +"$ref": "ProductReviewDestinationStatus" +}, +"readOnly": true, +"type": "array" +}, +"itemLevelIssues": { +"description": "Output only. A list of all issues associated with the product review.", +"items": { +"$ref": "ProductReviewItemLevelIssue" +}, +"readOnly": true, +"type": "array" +}, +"lastUpdateTime": { +"description": "Output only. Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ProductStatusChangeMessage": { +"description": "The message that the merchant will receive to notify about product status change event", +"id": "ProductStatusChangeMessage", +"properties": { +"account": { +"description": "The target account that owns the entity that changed. Format : `accounts/{merchant_id}`", +"type": "string" +}, +"attribute": { +"description": "The attribute in the resource that changed, in this case it will be always `Status`.", +"enum": [ +"ATTRIBUTE_UNSPECIFIED", +"STATUS" +], +"enumDescriptions": [ +"Unspecified attribute", +"Status of the changed entity" +], +"type": "string" +}, +"changes": { +"description": "A message to describe the change that happened to the product", +"items": { +"$ref": "ProductChange" +}, +"type": "array" +}, +"expirationTime": { +"description": "The product expiration time.", +"format": "google-datetime", +"type": "string" +}, +"managingAccount": { +"description": "The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id}`", +"type": "string" +}, +"resource": { +"description": "The product name. Format: `{product.name=accounts/{account}/products/{product}}`", +"type": "string" +}, +"resourceId": { +"description": "The product id.", +"type": "string" +}, +"resourceType": { +"description": "The resource that changed, in this case it will always be `Product`.", +"enum": [ +"RESOURCE_UNSPECIFIED", +"PRODUCT" +], +"enumDescriptions": [ +"Unspecified resource", +"Resource type : product" +], +"type": "string" +} +}, +"type": "object" +}, +"ReviewLink": { +"description": "The URI of the review landing page.", +"id": "ReviewLink", +"properties": { +"link": { +"description": "Optional. The URI of the review landing page. For example: `http://www.example.com/review_5.html`.", +"type": "string" +}, +"type": { +"description": "Optional. Type of the review URI.", +"enum": [ +"TYPE_UNSPECIFIED", +"SINGLETON", +"GROUP" +], +"enumDescriptions": [ +"Type unspecified.", +"The review page contains only this single review.", +"The review page contains a group of reviews including this review." +], +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Merchant API", +"version": "reviews_v1beta", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json index bc7c4c0eb0..30b14a627d 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json @@ -2309,7 +2309,7 @@ } } }, -"revision": "20241001", +"revision": "20241014", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2863,7 +2863,7 @@ "PERSISTENT_DISK_TYPE_SSD" ], "enumDescriptions": [ -"Unspecified (default value). Selecting this value allows the system to use any disk type according to reported usage. This a good value to start with.", +"Unspecified. Fallback to default value based on context.", "Standard HDD Persistent Disk.", "Balanced Persistent Disk.", "SSD Persistent Disk." @@ -2933,7 +2933,7 @@ "PERSISTENT_DISK_TYPE_SSD" ], "enumDescriptions": [ -"Unspecified (default value). Selecting this value allows the system to use any disk type according to reported usage. This a good value to start with.", +"Unspecified. Fallback to default value based on context.", "Standard HDD Persistent Disk.", "Balanced Persistent Disk.", "SSD Persistent Disk." @@ -5350,7 +5350,7 @@ "PERSISTENT_DISK_TYPE_SSD" ], "enumDescriptions": [ -"Unspecified (default value). Selecting this value allows the system to use any disk type according to reported usage. This a good value to start with.", +"Unspecified. Fallback to default value based on context.", "Standard HDD Persistent Disk.", "Balanced Persistent Disk.", "SSD Persistent Disk." diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json index d1db640256..b09ff778e9 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json @@ -2548,7 +2548,7 @@ } } }, -"revision": "20241001", +"revision": "20241014", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -3647,7 +3647,7 @@ "PERSISTENT_DISK_TYPE_SSD" ], "enumDescriptions": [ -"Unspecified (default value). Selecting this value allows the system to use any disk type according to reported usage. This a good value to start with.", +"Unspecified. Fallback to default value based on context.", "Standard HDD Persistent Disk.", "Balanced Persistent Disk.", "SSD Persistent Disk." @@ -3729,7 +3729,7 @@ "PERSISTENT_DISK_TYPE_SSD" ], "enumDescriptions": [ -"Unspecified (default value). Selecting this value allows the system to use any disk type according to reported usage. This a good value to start with.", +"Unspecified. Fallback to default value based on context.", "Standard HDD Persistent Disk.", "Balanced Persistent Disk.", "SSD Persistent Disk." @@ -4199,7 +4199,7 @@ "PERSISTENT_DISK_TYPE_SSD" ], "enumDescriptions": [ -"Unspecified (default value). Selecting this value allows the system to use any disk type according to reported usage. This a good value to start with.", +"Unspecified. Fallback to default value based on context.", "Standard HDD Persistent Disk.", "Balanced Persistent Disk.", "SSD Persistent Disk." @@ -7469,7 +7469,7 @@ false "PERSISTENT_DISK_TYPE_SSD" ], "enumDescriptions": [ -"Unspecified (default value). Selecting this value allows the system to use any disk type according to reported usage. This a good value to start with.", +"Unspecified. Fallback to default value based on context.", "Standard HDD Persistent Disk.", "Balanced Persistent Disk.", "SSD Persistent Disk." diff --git a/googleapiclient/discovery_cache/documents/monitoring.v3.json b/googleapiclient/discovery_cache/documents/monitoring.v3.json index 09c2fd01ed..26927930c4 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v3.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v3.json @@ -1427,7 +1427,7 @@ ], "parameters": { "force": { -"description": "If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.", +"description": "If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, this operation will fail if the notification channel is referenced by existing alerting policies.", "location": "query", "type": "boolean" }, @@ -2715,7 +2715,7 @@ } } }, -"revision": "20241003", +"revision": "20241017", "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 new file mode 100644 index 0000000000..e283aefaec --- /dev/null +++ b/googleapiclient/discovery_cache/documents/netapp.v1.json @@ -0,0 +1,3952 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/cloud-platform": { +"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +} +} +} +}, +"basePath": "", +"baseUrl": "https://netapp.googleapis.com/", +"batchPath": "batch", +"canonicalName": "NetApp Files", +"description": "Google Cloud NetApp Volumes is a fully-managed, cloud-based data storage service that provides advanced data management capabilities and highly scalable performance with global availability.", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/netapp/", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "netapp:v1", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://netapp.mtls.googleapis.com/", +"name": "netapp", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"projects": { +"resources": { +"locations": { +"methods": { +"get": { +"description": "Gets information about a location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Resource name for the location.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Location" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists information about the supported locations for this service.", +"flatPath": "v1/projects/{projectsId}/locations", +"httpMethod": "GET", +"id": "netapp.projects.locations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"name": { +"description": "The resource that owns the locations collection, if applicable.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The maximum number of results to return. If not set, the service selects a default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}/locations", +"response": { +"$ref": "ListLocationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"activeDirectories": { +"methods": { +"create": { +"description": "CreateActiveDirectory Creates the active directory specified in the request.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/activeDirectories", +"httpMethod": "POST", +"id": "netapp.projects.locations.activeDirectories.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"activeDirectoryId": { +"description": "Required. ID of the active directory to create. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter , the last a letter or a number, and a 63 character maximum.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Value for parent.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/activeDirectories", +"request": { +"$ref": "ActiveDirectory" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Delete the active directory specified in the request.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/activeDirectories/{activeDirectoriesId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.activeDirectories.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the active directory.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/activeDirectories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Describes a specified active directory.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/activeDirectories/{activeDirectoriesId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.activeDirectories.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the active directory.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/activeDirectories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "ActiveDirectory" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists active directories.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/activeDirectories", +"httpMethod": "GET", +"id": "netapp.projects.locations.activeDirectories.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Filtering results", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Hint for how to order the results", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListActiveDirectoriesRequest", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/activeDirectories", +"response": { +"$ref": "ListActiveDirectoriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Update the parameters of an active directories.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/activeDirectories/{activeDirectoriesId}", +"httpMethod": "PATCH", +"id": "netapp.projects.locations.activeDirectories.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/activeDirectories/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the Active Directory resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "ActiveDirectory" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"backupPolicies": { +"methods": { +"create": { +"description": "Creates new backup policy", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPolicies", +"httpMethod": "POST", +"id": "netapp.projects.locations.backupPolicies.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"backupPolicyId": { +"description": "Required. The ID to use for the backup policy. The ID must be unique within the specified location. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The location to create the backup policies of, in the format `projects/{project_id}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/backupPolicies", +"request": { +"$ref": "BackupPolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Warning! This operation will permanently delete the backup policy.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPolicies/{backupPoliciesId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.backupPolicies.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The backup policy resource name, in the format `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Returns the description of the specified backup policy by backup_policy_id.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPolicies/{backupPoliciesId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.backupPolicies.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The backupPolicy resource name, in the format `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "BackupPolicy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Returns list of all available backup policies.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPolicies", +"httpMethod": "GET", +"id": "netapp.projects.locations.backupPolicies.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Filtering results", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Hint for how to order the results", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListBackupPoliciesRequest", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/backupPolicies", +"response": { +"$ref": "ListBackupPoliciesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates settings of a specific backup policy.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPolicies/{backupPoliciesId}", +"httpMethod": "PATCH", +"id": "netapp.projects.locations.backupPolicies.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupPolicies/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the Backup Policy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "BackupPolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"backupVaults": { +"methods": { +"create": { +"description": "Creates new backup vault", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults", +"httpMethod": "POST", +"id": "netapp.projects.locations.backupVaults.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"backupVaultId": { +"description": "Required. The ID to use for the backupVault. The ID must be unique within the specified location. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The location to create the backup vaults, in the format `projects/{project_id}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/backupVaults", +"request": { +"$ref": "BackupVault" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Warning! This operation will permanently delete the backup vault.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.backupVaults.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The backupVault resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Returns the description of the specified backup vault", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.backupVaults.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The backupVault resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "BackupVault" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Returns list of all available backup vaults.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults", +"httpMethod": "GET", +"id": "netapp.projects.locations.backupVaults.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "List filter.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of items to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The next_page_token value to use if there are additional results to retrieve for this list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The location for which to retrieve backupVault information, in the format `projects/{project_id}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/backupVaults", +"response": { +"$ref": "ListBackupVaultsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the settings of a specific backup vault.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", +"httpMethod": "PATCH", +"id": "netapp.projects.locations.backupVaults.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the Backup resource to be updated. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "BackupVault" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"backups": { +"methods": { +"create": { +"description": "Creates a backup from the volume specified in the request The backup can be created from the given snapshot if specified in the request. If no snapshot specified, there'll be a new snapshot taken to initiate the backup creation.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups", +"httpMethod": "POST", +"id": "netapp.projects.locations.backupVaults.backups.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"backupId": { +"description": "Required. The ID to use for the backup. The ID must be unique within the specified backupVault. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The NetApp backupVault to create the backups of, in the format `projects/*/locations/*/backupVaults/{backup_vault_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/backups", +"request": { +"$ref": "Backup" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Warning! This operation will permanently delete the backup.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups/{backupsId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.backupVaults.backups.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The backup resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/backups/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Returns the description of the specified backup", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups/{backupsId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.backupVaults.backups.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The backup resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/backups/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Backup" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Returns descriptions of all backups for a backupVault.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups", +"httpMethod": "GET", +"id": "netapp.projects.locations.backupVaults.backups.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "The standard list filter. If specified, backups will be returned based on the attribute name that matches the filter expression. If empty, then no backups are filtered out. See https://google.aip.dev/160", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of items to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The next_page_token value to use if there are additional results to retrieve for this list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The backupVault for which to retrieve backup information, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`. To retrieve backup information for all locations, use \"-\" for the `{location}` value. To retrieve backup information for all backupVaults, use \"-\" for the `{backup_vault_id}` value. To retrieve backup information for a volume, use \"-\" for the `{backup_vault_id}` value and specify volume full name with the filter.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/backups", +"response": { +"$ref": "ListBackupsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Update backup with full spec.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups/{backupsId}", +"httpMethod": "PATCH", +"id": "netapp.projects.locations.backupVaults.backups.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/backups/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the Backup resource to be updated. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "Backup" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"kmsConfigs": { +"methods": { +"create": { +"description": "Creates a new KMS config.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/kmsConfigs", +"httpMethod": "POST", +"id": "netapp.projects.locations.kmsConfigs.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"kmsConfigId": { +"description": "Required. Id of the requesting KmsConfig. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Value for parent.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/kmsConfigs", +"request": { +"$ref": "KmsConfig" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Warning! This operation will permanently delete the Kms config.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.kmsConfigs.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the KmsConfig.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"encrypt": { +"description": "Encrypt the existing volumes without CMEK encryption with the desired the KMS config for the whole region.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}:encrypt", +"httpMethod": "POST", +"id": "netapp.projects.locations.kmsConfigs.encrypt", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the KmsConfig.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:encrypt", +"request": { +"$ref": "EncryptVolumesRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Returns the description of the specified KMS config by kms_config_id.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.kmsConfigs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the KmsConfig", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "KmsConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Returns descriptions of all KMS configs owned by the caller.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/kmsConfigs", +"httpMethod": "GET", +"id": "netapp.projects.locations.kmsConfigs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "List filter.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of items to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The next_page_token value to use if there are additional results to retrieve for this list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/kmsConfigs", +"response": { +"$ref": "ListKmsConfigsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the Kms config properties with the full spec", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}", +"httpMethod": "PATCH", +"id": "netapp.projects.locations.kmsConfigs.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Name of the KmsConfig.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the KmsConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "KmsConfig" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"verify": { +"description": "Verifies KMS config reachability.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}:verify", +"httpMethod": "POST", +"id": "netapp.projects.locations.kmsConfigs.verify", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the KMS Config to be verified.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:verify", +"request": { +"$ref": "VerifyKmsConfigRequest" +}, +"response": { +"$ref": "VerifyKmsConfigResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "netapp.projects.locations.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"request": { +"$ref": "CancelOperationRequest" +}, +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", +"httpMethod": "GET", +"id": "netapp.projects.locations.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "ListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"storagePools": { +"methods": { +"create": { +"description": "Creates a new storage pool.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools", +"httpMethod": "POST", +"id": "netapp.projects.locations.storagePools.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Value for parent.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"storagePoolId": { +"description": "Required. Id of the requesting storage pool. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/storagePools", +"request": { +"$ref": "StoragePool" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Warning! This operation will permanently delete the storage pool.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.storagePools.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the storage pool", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Returns the description of the specified storage pool by poolId.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.storagePools.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the storage pool", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "StoragePool" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Returns descriptions of all storage pools owned by the caller.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools", +"httpMethod": "GET", +"id": "netapp.projects.locations.storagePools.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. List filter.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of items to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value to use if there are additional results to retrieve for this list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/storagePools", +"response": { +"$ref": "ListStoragePoolsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the storage pool properties with the full spec", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}", +"httpMethod": "PATCH", +"id": "netapp.projects.locations.storagePools.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Name of the storage pool", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the StoragePool resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "StoragePool" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"switch": { +"description": "This operation will switch the active/replica zone for a regional storagePool.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:switch", +"httpMethod": "POST", +"id": "netapp.projects.locations.storagePools.switch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the storage pool", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:switch", +"request": { +"$ref": "SwitchActiveReplicaZoneRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"volumes": { +"methods": { +"create": { +"description": "Creates a new Volume in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes", +"httpMethod": "POST", +"id": "netapp.projects.locations.volumes.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Value for parent.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"volumeId": { +"description": "Required. Id of the requesting volume. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/volumes", +"request": { +"$ref": "Volume" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single Volume.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.volumes.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"force": { +"description": "If this field is set as true, CCFE will not block the volume resource deletion even if it has any snapshots resource. (Otherwise, the request will only work if the volume has no snapshots.)", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. Name of the volume", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single Volume.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.volumes.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the volume", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Volume" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Volumes in a given project.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes", +"httpMethod": "GET", +"id": "netapp.projects.locations.volumes.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Filtering results", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Hint for how to order the results", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListVolumesRequest", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/volumes", +"response": { +"$ref": "ListVolumesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of a single Volume.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}", +"httpMethod": "PATCH", +"id": "netapp.projects.locations.volumes.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Name of the volume", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the Volume resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "Volume" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"revert": { +"description": "Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:revert", +"httpMethod": "POST", +"id": "netapp.projects.locations.volumes.revert", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the volume, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:revert", +"request": { +"$ref": "RevertVolumeRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"replications": { +"methods": { +"create": { +"description": "Create a new replication for a volume.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications", +"httpMethod": "POST", +"id": "netapp.projects.locations.volumes.replications.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The NetApp volume to create the replications of, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +}, +"replicationId": { +"description": "Required. ID of the replication to create. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/replications", +"request": { +"$ref": "Replication" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a replication.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.volumes.replications.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The replication resource name, in the format `projects/*/locations/*/volumes/*/replications/{replication_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Describe a replication for a volume.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.volumes.replications.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The replication resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Replication" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Returns descriptions of all replications for a volume.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications", +"httpMethod": "GET", +"id": "netapp.projects.locations.volumes.replications.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "List filter.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of items to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The next_page_token value to use if there are additional results to retrieve for this list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The volume for which to retrieve replication information, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/replications", +"response": { +"$ref": "ListReplicationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the settings of a specific replication.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}", +"httpMethod": "PATCH", +"id": "netapp.projects.locations.volumes.replications.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Mask of fields to update. At least one path must be supplied in this field.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "Replication" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"resume": { +"description": "Resume Cross Region Replication.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}:resume", +"httpMethod": "POST", +"id": "netapp.projects.locations.volumes.replications.resume", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:resume", +"request": { +"$ref": "ResumeReplicationRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"reverseDirection": { +"description": "Reverses direction of replication. Source becomes destination and destination becomes source.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}:reverseDirection", +"httpMethod": "POST", +"id": "netapp.projects.locations.volumes.replications.reverseDirection", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:reverseDirection", +"request": { +"$ref": "ReverseReplicationDirectionRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"stop": { +"description": "Stop Cross Region Replication.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}:stop", +"httpMethod": "POST", +"id": "netapp.projects.locations.volumes.replications.stop", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:stop", +"request": { +"$ref": "StopReplicationRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"snapshots": { +"methods": { +"create": { +"description": "Create a new snapshot for a volume.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots", +"httpMethod": "POST", +"id": "netapp.projects.locations.volumes.snapshots.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The NetApp volume to create the snapshots of, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +}, +"snapshotId": { +"description": "Required. ID of the snapshot to create. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/snapshots", +"request": { +"$ref": "Snapshot" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a snapshot.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.volumes.snapshots.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The snapshot resource name, in the format `projects/*/locations/*/volumes/*/snapshots/{snapshot_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Describe a snapshot for a volume.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.volumes.snapshots.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The snapshot resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Snapshot" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Returns descriptions of all snapshots for a volume.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots", +"httpMethod": "GET", +"id": "netapp.projects.locations.volumes.snapshots.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "List filter.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of items to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The next_page_token value to use if there are additional results to retrieve for this list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The volume for which to retrieve snapshot information, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/snapshots", +"response": { +"$ref": "ListSnapshotsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the settings of a specific snapshot.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}", +"httpMethod": "PATCH", +"id": "netapp.projects.locations.volumes.snapshots.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the snapshot. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Mask of fields to update. At least one path must be supplied in this field.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "Snapshot" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +} +}, +"revision": "20241021", +"rootUrl": "https://netapp.googleapis.com/", +"schemas": { +"ActiveDirectory": { +"description": "ActiveDirectory is the public representation of the active directory config.", +"id": "ActiveDirectory", +"properties": { +"administrators": { +"description": "Optional. Users to be added to the Built-in Admininstrators group.", +"items": { +"type": "string" +}, +"type": "array" +}, +"aesEncryption": { +"description": "If enabled, AES encryption will be enabled for SMB communication.", +"type": "boolean" +}, +"backupOperators": { +"description": "Optional. Users to be added to the Built-in Backup Operator active directory group.", +"items": { +"type": "string" +}, +"type": "array" +}, +"createTime": { +"description": "Output only. Create time of the active directory.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Description of the active directory.", +"type": "string" +}, +"dns": { +"description": "Required. Comma separated list of DNS server IP addresses for the Active Directory domain.", +"type": "string" +}, +"domain": { +"description": "Required. Name of the Active Directory domain", +"type": "string" +}, +"encryptDcConnections": { +"description": "If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.", +"type": "boolean" +}, +"kdcHostname": { +"description": "Name of the active directory machine. This optional parameter is used only while creating kerberos volume", +"type": "string" +}, +"kdcIp": { +"description": "KDC server IP address for the active directory machine.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Labels for the active directory.", +"type": "object" +}, +"ldapSigning": { +"description": "Specifies whether or not the LDAP traffic needs to be signed.", +"type": "boolean" +}, +"name": { +"description": "Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.", +"type": "string" +}, +"netBiosPrefix": { +"description": "Required. NetBIOSPrefix is used as a prefix for SMB server name.", +"type": "string" +}, +"nfsUsersWithLdap": { +"description": "If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.", +"type": "boolean" +}, +"organizationalUnit": { +"description": "The Organizational Unit (OU) within the Windows Active Directory the user belongs to.", +"type": "string" +}, +"password": { +"description": "Required. Password of the Active Directory domain administrator.", +"type": "string" +}, +"securityOperators": { +"description": "Optional. Domain users to be given the SeSecurityPrivilege.", +"items": { +"type": "string" +}, +"type": "array" +}, +"site": { +"description": "The Active Directory site the service will limit Domain Controller discovery too.", +"type": "string" +}, +"state": { +"description": "Output only. The state of the AD.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"READY", +"UPDATING", +"IN_USE", +"DELETING", +"ERROR", +"DIAGNOSING" +], +"enumDescriptions": [ +"Unspecified Active Directory State", +"Active Directory State is Creating", +"Active Directory State is Ready", +"Active Directory State is Updating", +"Active Directory State is In use", +"Active Directory State is Deleting", +"Active Directory State is Error", +"Active Directory State is Diagnosing." +], +"readOnly": true, +"type": "string" +}, +"stateDetails": { +"description": "Output only. The state details of the Active Directory.", +"readOnly": true, +"type": "string" +}, +"username": { +"description": "Required. Username of the Active Directory domain administrator.", +"type": "string" +} +}, +"type": "object" +}, +"Backup": { +"description": "A NetApp Backup.", +"id": "Backup", +"properties": { +"backupType": { +"description": "Output only. Type of backup, manually created or created by a backup policy.", +"enum": [ +"TYPE_UNSPECIFIED", +"MANUAL", +"SCHEDULED" +], +"enumDescriptions": [ +"Unspecified backup type.", +"Manual backup type.", +"Scheduled backup type." +], +"readOnly": true, +"type": "string" +}, +"chainStorageBytes": { +"description": "Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time when the backup was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Resource labels to represent user provided metadata.", +"type": "object" +}, +"name": { +"description": "Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.", +"type": "string" +}, +"sourceSnapshot": { +"description": "If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`", +"type": "string" +}, +"sourceVolume": { +"description": "Volume full name of this backup belongs to. Format: `projects/{projects_id}/locations/{location}/volumes/{volume_id}`", +"type": "string" +}, +"state": { +"description": "Output only. The backup state.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"UPLOADING", +"READY", +"DELETING", +"ERROR", +"UPDATING" +], +"enumDescriptions": [ +"State not set.", +"Backup is being created. While in this state, the snapshot for the backup point-in-time may not have been created yet, and so the point-in-time may not have been fixed.", +"Backup is being uploaded. While in this state, none of the writes to the volume will be included in the backup.", +"Backup is available for use.", +"Backup is being deleted.", +"Backup is not valid and cannot be used for creating new volumes or restoring existing volumes.", +"Backup is being updated." +], +"readOnly": true, +"type": "string" +}, +"volumeUsageBytes": { +"description": "Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BackupConfig": { +"description": "BackupConfig contains backup related config on a volume.", +"id": "BackupConfig", +"properties": { +"backupChainBytes": { +"description": "Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"backupPolicies": { +"description": "Optional. When specified, schedule backups will be created based on the policy configuration.", +"items": { +"type": "string" +}, +"type": "array" +}, +"backupVault": { +"description": "Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}", +"type": "string" +}, +"scheduledBackupEnabled": { +"description": "Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.", +"type": "boolean" +} +}, +"type": "object" +}, +"BackupPolicy": { +"description": "Backup Policy.", +"id": "BackupPolicy", +"properties": { +"assignedVolumeCount": { +"description": "Output only. The total number of volumes assigned by this backup policy.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"createTime": { +"description": "Output only. The time when the backup policy was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dailyBackupLimit": { +"description": "Number of daily backups to keep. Note that the minimum daily backup limit is 2.", +"format": "int32", +"type": "integer" +}, +"description": { +"description": "Description of the backup policy.", +"type": "string" +}, +"enabled": { +"description": "If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.", +"type": "boolean" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Resource labels to represent user provided metadata.", +"type": "object" +}, +"monthlyBackupLimit": { +"description": "Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.", +"format": "int32", +"type": "integer" +}, +"name": { +"description": "Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.", +"type": "string" +}, +"state": { +"description": "Output only. The backup policy state.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"READY", +"DELETING", +"ERROR", +"UPDATING" +], +"enumDescriptions": [ +"State not set.", +"BackupPolicy is being created.", +"BackupPolicy is available for use.", +"BackupPolicy is being deleted.", +"BackupPolicy is not valid and cannot be used.", +"BackupPolicy is being updated." +], +"readOnly": true, +"type": "string" +}, +"weeklyBackupLimit": { +"description": "Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"BackupVault": { +"description": "A NetApp BackupVault.", +"id": "BackupVault", +"properties": { +"createTime": { +"description": "Output only. Create time of the backup vault.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Description of the backup vault.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Resource labels to represent user provided metadata.", +"type": "object" +}, +"name": { +"description": "Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.", +"type": "string" +}, +"state": { +"description": "Output only. The backup vault state.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"READY", +"DELETING", +"ERROR", +"UPDATING" +], +"enumDescriptions": [ +"State not set.", +"BackupVault is being created.", +"BackupVault is available for use.", +"BackupVault is being deleted.", +"BackupVault is not valid and cannot be used.", +"BackupVault is being updated." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CancelOperationRequest": { +"description": "The request message for Operations.CancelOperation.", +"id": "CancelOperationRequest", +"properties": {}, +"type": "object" +}, +"DailySchedule": { +"description": "Make a snapshot every day e.g. at 04:00, 05:20, 23:50", +"id": "DailySchedule", +"properties": { +"hour": { +"description": "Set the hour to start the snapshot (0-23), defaults to midnight (0).", +"format": "double", +"type": "number" +}, +"minute": { +"description": "Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).", +"format": "double", +"type": "number" +}, +"snapshotsToKeep": { +"description": "The maximum number of Snapshots to keep for the hourly schedule", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"DestinationVolumeParameters": { +"description": "DestinationVolumeParameters specify input parameters used for creating destination volume.", +"id": "DestinationVolumeParameters", +"properties": { +"description": { +"description": "Description for the destination volume.", +"type": "string" +}, +"shareName": { +"description": "Destination volume's share name. If not specified, source volume's share name will be used.", +"type": "string" +}, +"storagePool": { +"description": "Required. Existing destination StoragePool name.", +"type": "string" +}, +"volumeId": { +"description": "Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.", +"type": "string" +} +}, +"type": "object" +}, +"EncryptVolumesRequest": { +"description": "EncryptVolumesRequest specifies the KMS config to encrypt existing volumes.", +"id": "EncryptVolumesRequest", +"properties": {}, +"type": "object" +}, +"ExportPolicy": { +"description": "Defines the export policy for the volume.", +"id": "ExportPolicy", +"properties": { +"rules": { +"description": "Required. List of export policy rules", +"items": { +"$ref": "SimpleExportPolicyRule" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleProtobufEmpty": { +"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": "GoogleProtobufEmpty", +"properties": {}, +"type": "object" +}, +"HourlySchedule": { +"description": "Make a snapshot every hour e.g. at 04:00, 05:00, 06:00.", +"id": "HourlySchedule", +"properties": { +"minute": { +"description": "Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).", +"format": "double", +"type": "number" +}, +"snapshotsToKeep": { +"description": "The maximum number of Snapshots to keep for the hourly schedule", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"KmsConfig": { +"description": "KmsConfig is the customer managed encryption key(CMEK) configuration.", +"id": "KmsConfig", +"properties": { +"createTime": { +"description": "Output only. Create time of the KmsConfig.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"cryptoKeyName": { +"description": "Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.", +"type": "string" +}, +"description": { +"description": "Description of the KmsConfig.", +"type": "string" +}, +"instructions": { +"description": "Output only. Instructions to provide the access to the customer provided encryption key.", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Labels as key value pairs", +"type": "object" +}, +"name": { +"description": "Identifier. Name of the KmsConfig.", +"type": "string" +}, +"serviceAccount": { +"description": "Output only. The Service account which will have access to the customer provided encryption key.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. State of the KmsConfig.", +"enum": [ +"STATE_UNSPECIFIED", +"READY", +"CREATING", +"DELETING", +"UPDATING", +"IN_USE", +"ERROR", +"KEY_CHECK_PENDING", +"KEY_NOT_REACHABLE", +"DISABLING", +"DISABLED", +"MIGRATING" +], +"enumDescriptions": [ +"Unspecified KmsConfig State", +"KmsConfig State is Ready", +"KmsConfig State is Creating", +"KmsConfig State is Deleting", +"KmsConfig State is Updating", +"KmsConfig State is In Use.", +"KmsConfig State is Error", +"KmsConfig State is Pending to verify crypto key access.", +"KmsConfig State is Not accessbile by the SDE service account to the crypto key.", +"KmsConfig State is Disabling.", +"KmsConfig State is Disabled.", +"KmsConfig State is Migrating. The existing volumes are migrating from SMEK to CMEK." +], +"readOnly": true, +"type": "string" +}, +"stateDetails": { +"description": "Output only. State details of the KmsConfig.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ListActiveDirectoriesResponse": { +"description": "ListActiveDirectoriesResponse contains all the active directories requested.", +"id": "ListActiveDirectoriesResponse", +"properties": { +"activeDirectories": { +"description": "The list of active directories.", +"items": { +"$ref": "ActiveDirectory" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListBackupPoliciesResponse": { +"description": "ListBackupPoliciesResponse contains all the backup policies requested.", +"id": "ListBackupPoliciesResponse", +"properties": { +"backupPolicies": { +"description": "The list of backup policies.", +"items": { +"$ref": "BackupPolicy" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListBackupVaultsResponse": { +"description": "ListBackupVaultsResponse is the result of ListBackupVaultsRequest.", +"id": "ListBackupVaultsResponse", +"properties": { +"backupVaults": { +"description": "A list of backupVaults in the project for the specified location.", +"items": { +"$ref": "BackupVault" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListBackupsResponse": { +"description": "ListBackupsResponse is the result of ListBackupsRequest.", +"id": "ListBackupsResponse", +"properties": { +"backups": { +"description": "A list of backups in the project.", +"items": { +"$ref": "Backup" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListKmsConfigsResponse": { +"description": "ListKmsConfigsResponse is the response to a ListKmsConfigsRequest.", +"id": "ListKmsConfigsResponse", +"properties": { +"kmsConfigs": { +"description": "The list of KmsConfigs", +"items": { +"$ref": "KmsConfig" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListLocationsResponse": { +"description": "The response message for Locations.ListLocations.", +"id": "ListLocationsResponse", +"properties": { +"locations": { +"description": "A list of locations that matches the specified filter in the request.", +"items": { +"$ref": "Location" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +} +}, +"type": "object" +}, +"ListOperationsResponse": { +"description": "The response message for Operations.ListOperations.", +"id": "ListOperationsResponse", +"properties": { +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +}, +"operations": { +"description": "A list of operations that matches the specified filter in the request.", +"items": { +"$ref": "Operation" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListReplicationsResponse": { +"description": "ListReplicationsResponse is the result of ListReplicationsRequest.", +"id": "ListReplicationsResponse", +"properties": { +"nextPageToken": { +"description": "The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.", +"type": "string" +}, +"replications": { +"description": "A list of replications in the project for the specified volume.", +"items": { +"$ref": "Replication" +}, +"type": "array" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListSnapshotsResponse": { +"description": "ListSnapshotsResponse is the result of ListSnapshotsRequest.", +"id": "ListSnapshotsResponse", +"properties": { +"nextPageToken": { +"description": "The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.", +"type": "string" +}, +"snapshots": { +"description": "A list of snapshots in the project for the specified volume.", +"items": { +"$ref": "Snapshot" +}, +"type": "array" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListStoragePoolsResponse": { +"description": "ListStoragePoolsResponse is the response to a ListStoragePoolsRequest.", +"id": "ListStoragePoolsResponse", +"properties": { +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"storagePools": { +"description": "The list of StoragePools", +"items": { +"$ref": "StoragePool" +}, +"type": "array" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListVolumesResponse": { +"description": "Message for response to listing Volumes", +"id": "ListVolumesResponse", +"properties": { +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +}, +"volumes": { +"description": "The list of Volume", +"items": { +"$ref": "Volume" +}, +"type": "array" +} +}, +"type": "object" +}, +"Location": { +"description": "A resource that represents a Google Cloud location.", +"id": "Location", +"properties": { +"displayName": { +"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", +"type": "object" +}, +"locationId": { +"description": "The canonical id for this location. For example: `\"us-east1\"`.", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Service-specific metadata. For example the available capacity at the given location.", +"type": "object" +}, +"name": { +"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", +"type": "string" +} +}, +"type": "object" +}, +"LocationMetadata": { +"description": "Metadata for a given google.cloud.location.Location.", +"id": "LocationMetadata", +"properties": { +"supportedServiceLevels": { +"description": "Output only. Supported service levels in a location.", +"items": { +"enum": [ +"SERVICE_LEVEL_UNSPECIFIED", +"PREMIUM", +"EXTREME", +"STANDARD", +"FLEX" +], +"enumDescriptions": [ +"Unspecified service level.", +"Premium service level.", +"Extreme service level.", +"Standard service level.", +"Flex service level." +], +"type": "string" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"MonthlySchedule": { +"description": "Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50", +"id": "MonthlySchedule", +"properties": { +"daysOfMonth": { +"description": "Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.", +"type": "string" +}, +"hour": { +"description": "Set the hour to start the snapshot (0-23), defaults to midnight (0).", +"format": "double", +"type": "number" +}, +"minute": { +"description": "Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).", +"format": "double", +"type": "number" +}, +"snapshotsToKeep": { +"description": "The maximum number of Snapshots to keep for the hourly schedule", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"MountOption": { +"description": "View only mount options for a volume.", +"id": "MountOption", +"properties": { +"export": { +"description": "Export string", +"type": "string" +}, +"exportFull": { +"description": "Full export string", +"type": "string" +}, +"instructions": { +"description": "Instructions for mounting", +"type": "string" +}, +"protocol": { +"description": "Protocol to mount with.", +"enum": [ +"PROTOCOLS_UNSPECIFIED", +"NFSV3", +"NFSV4", +"SMB" +], +"enumDescriptions": [ +"Unspecified protocol", +"NFS V3 protocol", +"NFS V4 protocol", +"SMB protocol" +], +"type": "string" +} +}, +"type": "object" +}, +"Operation": { +"description": "This resource represents a long-running operation that is the result of a network API call.", +"id": "Operation", +"properties": { +"done": { +"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", +"type": "boolean" +}, +"error": { +"$ref": "Status", +"description": "The error result of the operation in case of failure or cancellation." +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", +"type": "object" +}, +"name": { +"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", +"type": "string" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", +"type": "object" +} +}, +"type": "object" +}, +"OperationMetadata": { +"description": "Represents the metadata of the long-running operation.", +"id": "OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been canceled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Replication": { +"description": "Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.", +"id": "Replication", +"properties": { +"createTime": { +"description": "Output only. Replication create time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "A description about this replication relationship.", +"type": "string" +}, +"destinationVolume": { +"description": "Output only. Full name of destination volume resource. Example : \"projects/{project}/locations/{location}/volumes/{volume_id}\"", +"readOnly": true, +"type": "string" +}, +"destinationVolumeParameters": { +"$ref": "DestinationVolumeParameters", +"description": "Required. Input only. Destination volume parameters" +}, +"healthy": { +"description": "Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.", +"readOnly": true, +"type": "boolean" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Resource labels to represent user provided metadata.", +"type": "object" +}, +"mirrorState": { +"description": "Output only. Indicates the state of mirroring.", +"enum": [ +"MIRROR_STATE_UNSPECIFIED", +"PREPARING", +"MIRRORED", +"STOPPED", +"TRANSFERRING" +], +"enumDescriptions": [ +"Unspecified MirrorState", +"Destination volume is being prepared.", +"Destination volume has been initialized and is ready to receive replication transfers.", +"Destination volume is not receiving replication transfers.", +"Incremental replication is in progress." +], +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.", +"type": "string" +}, +"replicationSchedule": { +"description": "Required. Indicates the schedule for replication.", +"enum": [ +"REPLICATION_SCHEDULE_UNSPECIFIED", +"EVERY_10_MINUTES", +"HOURLY", +"DAILY" +], +"enumDescriptions": [ +"Unspecified ReplicationSchedule", +"Replication happens once every 10 minutes.", +"Replication happens once every hour.", +"Replication happens once every day." +], +"type": "string" +}, +"role": { +"description": "Output only. Indicates whether this points to source or destination.", +"enum": [ +"REPLICATION_ROLE_UNSPECIFIED", +"SOURCE", +"DESTINATION" +], +"enumDescriptions": [ +"Unspecified replication role", +"Indicates Source volume.", +"Indicates Destination volume." +], +"readOnly": true, +"type": "string" +}, +"sourceVolume": { +"description": "Output only. Full name of source volume resource. Example : \"projects/{project}/locations/{location}/volumes/{volume_id}\"", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. State of the replication.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"READY", +"UPDATING", +"DELETING", +"ERROR" +], +"enumDescriptions": [ +"Unspecified replication State", +"Replication is creating.", +"Replication is ready.", +"Replication is updating.", +"Replication is deleting.", +"Replication is in error state." +], +"readOnly": true, +"type": "string" +}, +"stateDetails": { +"description": "Output only. State details of the replication.", +"readOnly": true, +"type": "string" +}, +"transferStats": { +"$ref": "TransferStats", +"description": "Output only. Replication transfer statistics.", +"readOnly": true +} +}, +"type": "object" +}, +"RestoreParameters": { +"description": "The RestoreParameters if volume is created from a snapshot or backup.", +"id": "RestoreParameters", +"properties": { +"sourceBackup": { +"description": "Full name of the backup resource. Format: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}", +"type": "string" +}, +"sourceSnapshot": { +"description": "Full name of the snapshot resource. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}", +"type": "string" +} +}, +"type": "object" +}, +"ResumeReplicationRequest": { +"description": "ResumeReplicationRequest resumes a stopped replication.", +"id": "ResumeReplicationRequest", +"properties": {}, +"type": "object" +}, +"ReverseReplicationDirectionRequest": { +"description": "ReverseReplicationDirectionRequest reverses direction of replication. Source becomes destination and destination becomes source.", +"id": "ReverseReplicationDirectionRequest", +"properties": {}, +"type": "object" +}, +"RevertVolumeRequest": { +"description": "RevertVolumeRequest reverts the given volume to the specified snapshot.", +"id": "RevertVolumeRequest", +"properties": { +"snapshotId": { +"description": "Required. The snapshot resource ID, in the format 'my-snapshot', where the specified ID is the {snapshot_id} of the fully qualified name like projects/{project_id}/locations/{location_id}/volumes/{volume_id}/snapshots/{snapshot_id}", +"type": "string" +} +}, +"type": "object" +}, +"SimpleExportPolicyRule": { +"description": "An export policy rule describing various export options.", +"id": "SimpleExportPolicyRule", +"properties": { +"accessType": { +"description": "Access type (ReadWrite, ReadOnly, None)", +"enum": [ +"ACCESS_TYPE_UNSPECIFIED", +"READ_ONLY", +"READ_WRITE", +"READ_NONE" +], +"enumDescriptions": [ +"Unspecified Access Type", +"Read Only", +"Read Write", +"None" +], +"type": "string" +}, +"allowedClients": { +"description": "Comma separated list of allowed clients IP addresses", +"type": "string" +}, +"hasRootAccess": { +"description": "Whether Unix root access will be granted.", +"type": "string" +}, +"kerberos5ReadOnly": { +"description": "If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.", +"type": "boolean" +}, +"kerberos5ReadWrite": { +"description": "If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled.", +"type": "boolean" +}, +"kerberos5iReadOnly": { +"description": "If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.", +"type": "boolean" +}, +"kerberos5iReadWrite": { +"description": "If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value be ignored if this is enabled.", +"type": "boolean" +}, +"kerberos5pReadOnly": { +"description": "If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.", +"type": "boolean" +}, +"kerberos5pReadWrite": { +"description": "If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value be ignored if this is enabled.", +"type": "boolean" +}, +"nfsv3": { +"description": "NFS V3 protocol.", +"type": "boolean" +}, +"nfsv4": { +"description": "NFS V4 protocol.", +"type": "boolean" +} +}, +"type": "object" +}, +"Snapshot": { +"description": "Snapshot is a point-in-time version of a Volume's content.", +"id": "Snapshot", +"properties": { +"createTime": { +"description": "Output only. The time when the snapshot was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Resource labels to represent user provided metadata.", +"type": "object" +}, +"name": { +"description": "Identifier. The resource name of the snapshot. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`.", +"type": "string" +}, +"state": { +"description": "Output only. The snapshot state.", +"enum": [ +"STATE_UNSPECIFIED", +"READY", +"CREATING", +"DELETING", +"UPDATING", +"DISABLED", +"ERROR" +], +"enumDescriptions": [ +"Unspecified Snapshot State", +"Snapshot State is Ready", +"Snapshot State is Creating", +"Snapshot State is Deleting", +"Snapshot State is Updating", +"Snapshot State is Disabled", +"Snapshot State is Error" +], +"readOnly": true, +"type": "string" +}, +"stateDetails": { +"description": "Output only. State details of the storage pool", +"readOnly": true, +"type": "string" +}, +"usedBytes": { +"description": "Output only. Current storage usage for the snapshot in bytes.", +"format": "double", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, +"SnapshotPolicy": { +"description": "Snapshot Policy for a volume.", +"id": "SnapshotPolicy", +"properties": { +"dailySchedule": { +"$ref": "DailySchedule", +"description": "Daily schedule policy." +}, +"enabled": { +"description": "If enabled, make snapshots automatically according to the schedules. Default is false.", +"type": "boolean" +}, +"hourlySchedule": { +"$ref": "HourlySchedule", +"description": "Hourly schedule policy." +}, +"monthlySchedule": { +"$ref": "MonthlySchedule", +"description": "Monthly schedule policy." +}, +"weeklySchedule": { +"$ref": "WeeklySchedule", +"description": "Weekly schedule policy." +} +}, +"type": "object" +}, +"Status": { +"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", +"id": "Status", +"properties": { +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", +"format": "int32", +"type": "integer" +}, +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", +"type": "string" +} +}, +"type": "object" +}, +"StopReplicationRequest": { +"description": "StopReplicationRequest stops a replication until resumed.", +"id": "StopReplicationRequest", +"properties": { +"force": { +"description": "Indicates whether to stop replication forcefully while data transfer is in progress. Warning! if force is true, this will abort any current transfers and can lead to data loss due to partial transfer. If force is false, stop replication will fail while data transfer is in progress and you will need to retry later.", +"type": "boolean" +} +}, +"type": "object" +}, +"StoragePool": { +"description": "StoragePool is a container for volumes with a service level and capacity. Volumes can be created in a pool of sufficient available capacity. StoragePool capacity is what you are billed for.", +"id": "StoragePool", +"properties": { +"activeDirectory": { +"description": "Optional. Specifies the Active Directory to be used for creating a SMB volume.", +"type": "string" +}, +"allowAutoTiering": { +"description": "Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.", +"type": "boolean" +}, +"capacityGib": { +"description": "Required. Capacity in GIB of the pool", +"format": "int64", +"type": "string" +}, +"createTime": { +"description": "Output only. Create time of the storage pool", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. Description of the storage pool", +"type": "string" +}, +"encryptionType": { +"description": "Output only. Specifies the current pool encryption key source.", +"enum": [ +"ENCRYPTION_TYPE_UNSPECIFIED", +"SERVICE_MANAGED", +"CLOUD_KMS" +], +"enumDescriptions": [ +"The source of the encryption key is not specified.", +"Google managed encryption key.", +"Customer managed encryption key, which is stored in KMS." +], +"readOnly": true, +"type": "string" +}, +"globalAccessAllowed": { +"deprecated": true, +"description": "Deprecated. Used to allow SO pool to access AD or DNS server from other regions.", +"type": "boolean" +}, +"kmsConfig": { +"description": "Optional. Specifies the KMS config to be used for volume encryption.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels as key value pairs", +"type": "object" +}, +"ldapEnabled": { +"description": "Optional. Flag indicating if the pool is NFS LDAP enabled or not.", +"type": "boolean" +}, +"name": { +"description": "Identifier. Name of the storage pool", +"type": "string" +}, +"network": { +"description": "Required. VPC Network name. Format: projects/{project}/global/networks/{network}", +"type": "string" +}, +"psaRange": { +"description": "Optional. This field is not implemented. The values provided in this field are ignored.", +"type": "string" +}, +"replicaZone": { +"description": "Optional. Specifies the replica zone for regional storagePool.", +"type": "string" +}, +"serviceLevel": { +"description": "Required. Service level of the storage pool", +"enum": [ +"SERVICE_LEVEL_UNSPECIFIED", +"PREMIUM", +"EXTREME", +"STANDARD", +"FLEX" +], +"enumDescriptions": [ +"Unspecified service level.", +"Premium service level.", +"Extreme service level.", +"Standard service level.", +"Flex service level." +], +"type": "string" +}, +"state": { +"description": "Output only. State of the storage pool", +"enum": [ +"STATE_UNSPECIFIED", +"READY", +"CREATING", +"DELETING", +"UPDATING", +"RESTORING", +"DISABLED", +"ERROR" +], +"enumDescriptions": [ +"Unspecified Storage Pool State", +"Storage Pool State is Ready", +"Storage Pool State is Creating", +"Storage Pool State is Deleting", +"Storage Pool State is Updating", +"Storage Pool State is Restoring", +"Storage Pool State is Disabled", +"Storage Pool State is Error" +], +"readOnly": true, +"type": "string" +}, +"stateDetails": { +"description": "Output only. State details of the storage pool", +"readOnly": true, +"type": "string" +}, +"volumeCapacityGib": { +"description": "Output only. Allocated size of all volumes in GIB in the storage pool", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"volumeCount": { +"description": "Output only. Volume count of the storage pool", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"zone": { +"description": "Optional. Specifies the active zone for regional storagePool.", +"type": "string" +} +}, +"type": "object" +}, +"SwitchActiveReplicaZoneRequest": { +"description": "SwitchActiveReplicaZoneRequest switch the active/replica zone for a regional storagePool.", +"id": "SwitchActiveReplicaZoneRequest", +"properties": {}, +"type": "object" +}, +"TieringPolicy": { +"description": "Defines tiering policy for the volume.", +"id": "TieringPolicy", +"properties": { +"coolingThresholdDays": { +"description": "Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31.", +"format": "int32", +"type": "integer" +}, +"tierAction": { +"description": "Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.", +"enum": [ +"TIER_ACTION_UNSPECIFIED", +"ENABLED", +"PAUSED" +], +"enumDescriptions": [ +"Unspecified.", +"When tiering is enabled, new cold data will be tiered.", +"When paused, tiering won't be performed on new data. Existing data stays tiered until accessed." +], +"type": "string" +} +}, +"type": "object" +}, +"TransferStats": { +"description": "TransferStats reports all statistics related to replication transfer.", +"id": "TransferStats", +"properties": { +"lagDuration": { +"description": "Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.", +"format": "google-duration", +"type": "string" +}, +"lastTransferBytes": { +"description": "Last transfer size in bytes.", +"format": "int64", +"type": "string" +}, +"lastTransferDuration": { +"description": "Time taken during last transfer.", +"format": "google-duration", +"type": "string" +}, +"lastTransferEndTime": { +"description": "Time when last transfer completed.", +"format": "google-datetime", +"type": "string" +}, +"lastTransferError": { +"description": "A message describing the cause of the last transfer failure.", +"type": "string" +}, +"totalTransferDuration": { +"description": "Cumulative time taken across all transfers for the replication relationship.", +"format": "google-duration", +"type": "string" +}, +"transferBytes": { +"description": "Cumulative bytes trasferred so far for the replication relatinonship.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Time when progress was updated last.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"VerifyKmsConfigRequest": { +"description": "VerifyKmsConfigRequest specifies the KMS config to be validated.", +"id": "VerifyKmsConfigRequest", +"properties": {}, +"type": "object" +}, +"VerifyKmsConfigResponse": { +"description": "VerifyKmsConfigResponse contains the information if the config is correctly and error message.", +"id": "VerifyKmsConfigResponse", +"properties": { +"healthError": { +"description": "Output only. Error message if config is not healthy.", +"readOnly": true, +"type": "string" +}, +"healthy": { +"description": "Output only. If the customer key configured correctly to the encrypt volume.", +"readOnly": true, +"type": "boolean" +}, +"instructions": { +"description": "Output only. Instructions for the customers to provide the access to the encryption key.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Volume": { +"description": "Volume provides a filesystem that you can mount.", +"id": "Volume", +"properties": { +"activeDirectory": { +"description": "Output only. Specifies the ActiveDirectory name of a SMB volume.", +"readOnly": true, +"type": "string" +}, +"backupConfig": { +"$ref": "BackupConfig", +"description": "BackupConfig of the volume." +}, +"capacityGib": { +"description": "Required. Capacity in GIB of the volume", +"format": "int64", +"type": "string" +}, +"coldTierSizeGib": { +"description": "Output only. Size of the volume cold tier data in GiB.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. Create time of the volume", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. Description of the volume", +"type": "string" +}, +"encryptionType": { +"description": "Output only. Specified the current volume encryption key source.", +"enum": [ +"ENCRYPTION_TYPE_UNSPECIFIED", +"SERVICE_MANAGED", +"CLOUD_KMS" +], +"enumDescriptions": [ +"The source of the encryption key is not specified.", +"Google managed encryption key.", +"Customer managed encryption key, which is stored in KMS." +], +"readOnly": true, +"type": "string" +}, +"exportPolicy": { +"$ref": "ExportPolicy", +"description": "Optional. Export policy of the volume" +}, +"hasReplication": { +"description": "Output only. Indicates whether the volume is part of a replication relationship.", +"readOnly": true, +"type": "boolean" +}, +"kerberosEnabled": { +"description": "Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).", +"type": "boolean" +}, +"kmsConfig": { +"description": "Output only. Specifies the KMS config to be used for volume encryption.", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels as key value pairs", +"type": "object" +}, +"largeCapacity": { +"description": "Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.", +"type": "boolean" +}, +"ldapEnabled": { +"description": "Output only. Flag indicating if the volume is NFS LDAP enabled or not.", +"readOnly": true, +"type": "boolean" +}, +"mountOptions": { +"description": "Output only. Mount options of this volume", +"items": { +"$ref": "MountOption" +}, +"readOnly": true, +"type": "array" +}, +"multipleEndpoints": { +"description": "Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.", +"type": "boolean" +}, +"name": { +"description": "Identifier. Name of the volume", +"type": "string" +}, +"network": { +"description": "Output only. VPC Network name. Format: projects/{project}/global/networks/{network}", +"readOnly": true, +"type": "string" +}, +"protocols": { +"description": "Required. Protocols required for the volume", +"items": { +"enum": [ +"PROTOCOLS_UNSPECIFIED", +"NFSV3", +"NFSV4", +"SMB" +], +"enumDescriptions": [ +"Unspecified protocol", +"NFS V3 protocol", +"NFS V4 protocol", +"SMB protocol" +], +"type": "string" +}, +"type": "array" +}, +"psaRange": { +"description": "Output only. This field is not implemented. The values provided in this field are ignored.", +"readOnly": true, +"type": "string" +}, +"replicaZone": { +"description": "Output only. Specifies the replica zone for regional volume.", +"readOnly": true, +"type": "string" +}, +"restoreParameters": { +"$ref": "RestoreParameters", +"description": "Optional. Specifies the source of the volume to be created from." +}, +"restrictedActions": { +"description": "Optional. List of actions that are restricted on this volume.", +"items": { +"enum": [ +"RESTRICTED_ACTION_UNSPECIFIED", +"DELETE" +], +"enumDescriptions": [ +"Unspecified restricted action", +"Prevent volume from being deleted when mounted." +], +"type": "string" +}, +"type": "array" +}, +"securityStyle": { +"description": "Optional. Security Style of the Volume", +"enum": [ +"SECURITY_STYLE_UNSPECIFIED", +"NTFS", +"UNIX" +], +"enumDescriptions": [ +"SecurityStyle is unspecified", +"SecurityStyle uses NTFS", +"SecurityStyle uses UNIX" +], +"type": "string" +}, +"serviceLevel": { +"description": "Output only. Service level of the volume", +"enum": [ +"SERVICE_LEVEL_UNSPECIFIED", +"PREMIUM", +"EXTREME", +"STANDARD", +"FLEX" +], +"enumDescriptions": [ +"Unspecified service level.", +"Premium service level.", +"Extreme service level.", +"Standard service level.", +"Flex service level." +], +"readOnly": true, +"type": "string" +}, +"shareName": { +"description": "Required. Share name of the volume", +"type": "string" +}, +"smbSettings": { +"description": "Optional. SMB share settings for the volume.", +"items": { +"enum": [ +"SMB_SETTINGS_UNSPECIFIED", +"ENCRYPT_DATA", +"BROWSABLE", +"CHANGE_NOTIFY", +"NON_BROWSABLE", +"OPLOCKS", +"SHOW_SNAPSHOT", +"SHOW_PREVIOUS_VERSIONS", +"ACCESS_BASED_ENUMERATION", +"CONTINUOUSLY_AVAILABLE" +], +"enumDescriptions": [ +"Unspecified default option", +"SMB setting encrypt data", +"SMB setting browsable", +"SMB setting notify change", +"SMB setting not to notify change", +"SMB setting oplocks", +"SMB setting to show snapshots", +"SMB setting to show previous versions", +"SMB setting to access volume based on enumerartion", +"Continuously available enumeration" +], +"type": "string" +}, +"type": "array" +}, +"snapReserve": { +"description": "Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.", +"format": "double", +"type": "number" +}, +"snapshotDirectory": { +"description": "Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.", +"type": "boolean" +}, +"snapshotPolicy": { +"$ref": "SnapshotPolicy", +"description": "Optional. SnapshotPolicy for a volume." +}, +"state": { +"description": "Output only. State of the volume", +"enum": [ +"STATE_UNSPECIFIED", +"READY", +"CREATING", +"DELETING", +"UPDATING", +"RESTORING", +"DISABLED", +"ERROR" +], +"enumDescriptions": [ +"Unspecified Volume State", +"Volume State is Ready", +"Volume State is Creating", +"Volume State is Deleting", +"Volume State is Updating", +"Volume State is Restoring", +"Volume State is Disabled", +"Volume State is Error" +], +"readOnly": true, +"type": "string" +}, +"stateDetails": { +"description": "Output only. State details of the volume", +"readOnly": true, +"type": "string" +}, +"storagePool": { +"description": "Required. StoragePool name of the volume", +"type": "string" +}, +"tieringPolicy": { +"$ref": "TieringPolicy", +"description": "Tiering policy for the volume." +}, +"unixPermissions": { +"description": "Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.", +"type": "string" +}, +"usedGib": { +"description": "Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"zone": { +"description": "Output only. Specifies the active zone for regional volume.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"WeeklySchedule": { +"description": "Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50", +"id": "WeeklySchedule", +"properties": { +"day": { +"description": "Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.", +"type": "string" +}, +"hour": { +"description": "Set the hour to start the snapshot (0-23), defaults to midnight (0).", +"format": "double", +"type": "number" +}, +"minute": { +"description": "Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).", +"format": "double", +"type": "number" +}, +"snapshotsToKeep": { +"description": "The maximum number of Snapshots to keep for the hourly schedule", +"format": "double", +"type": "number" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "NetApp API", +"version": "v1", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json new file mode 100644 index 0000000000..2bf3923c42 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json @@ -0,0 +1,3952 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/cloud-platform": { +"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +} +} +} +}, +"basePath": "", +"baseUrl": "https://netapp.googleapis.com/", +"batchPath": "batch", +"canonicalName": "NetApp Files", +"description": "Google Cloud NetApp Volumes is a fully-managed, cloud-based data storage service that provides advanced data management capabilities and highly scalable performance with global availability.", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/netapp/", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "netapp:v1beta1", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://netapp.mtls.googleapis.com/", +"name": "netapp", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"projects": { +"resources": { +"locations": { +"methods": { +"get": { +"description": "Gets information about a location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Resource name for the location.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Location" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists information about the supported locations for this service.", +"flatPath": "v1beta1/projects/{projectsId}/locations", +"httpMethod": "GET", +"id": "netapp.projects.locations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"name": { +"description": "The resource that owns the locations collection, if applicable.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The maximum number of results to return. If not set, the service selects a default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}/locations", +"response": { +"$ref": "ListLocationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"activeDirectories": { +"methods": { +"create": { +"description": "CreateActiveDirectory Creates the active directory specified in the request.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/activeDirectories", +"httpMethod": "POST", +"id": "netapp.projects.locations.activeDirectories.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"activeDirectoryId": { +"description": "Required. ID of the active directory to create. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter , the last a letter or a number, and a 63 character maximum.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Value for parent.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/activeDirectories", +"request": { +"$ref": "ActiveDirectory" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Delete the active directory specified in the request.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/activeDirectories/{activeDirectoriesId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.activeDirectories.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the active directory.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/activeDirectories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Describes a specified active directory.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/activeDirectories/{activeDirectoriesId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.activeDirectories.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the active directory.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/activeDirectories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "ActiveDirectory" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists active directories.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/activeDirectories", +"httpMethod": "GET", +"id": "netapp.projects.locations.activeDirectories.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Filtering results", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Hint for how to order the results", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListActiveDirectoriesRequest", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/activeDirectories", +"response": { +"$ref": "ListActiveDirectoriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Update the parameters of an active directories.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/activeDirectories/{activeDirectoriesId}", +"httpMethod": "PATCH", +"id": "netapp.projects.locations.activeDirectories.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/activeDirectories/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the Active Directory resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "ActiveDirectory" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"backupPolicies": { +"methods": { +"create": { +"description": "Creates new backup policy", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupPolicies", +"httpMethod": "POST", +"id": "netapp.projects.locations.backupPolicies.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"backupPolicyId": { +"description": "Required. The ID to use for the backup policy. The ID must be unique within the specified location. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The location to create the backup policies of, in the format `projects/{project_id}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/backupPolicies", +"request": { +"$ref": "BackupPolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Warning! This operation will permanently delete the backup policy.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupPolicies/{backupPoliciesId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.backupPolicies.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The backup policy resource name, in the format `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Returns the description of the specified backup policy by backup_policy_id.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupPolicies/{backupPoliciesId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.backupPolicies.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The backupPolicy resource name, in the format `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "BackupPolicy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Returns list of all available backup policies.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupPolicies", +"httpMethod": "GET", +"id": "netapp.projects.locations.backupPolicies.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Filtering results", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Hint for how to order the results", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListBackupPoliciesRequest", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/backupPolicies", +"response": { +"$ref": "ListBackupPoliciesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates settings of a specific backup policy.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupPolicies/{backupPoliciesId}", +"httpMethod": "PATCH", +"id": "netapp.projects.locations.backupPolicies.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupPolicies/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the Backup Policy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "BackupPolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"backupVaults": { +"methods": { +"create": { +"description": "Creates new backup vault", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults", +"httpMethod": "POST", +"id": "netapp.projects.locations.backupVaults.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"backupVaultId": { +"description": "Required. The ID to use for the backupVault. The ID must be unique within the specified location. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The location to create the backup vaults, in the format `projects/{project_id}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/backupVaults", +"request": { +"$ref": "BackupVault" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Warning! This operation will permanently delete the backup vault.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.backupVaults.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The backupVault resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Returns the description of the specified backup vault", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.backupVaults.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The backupVault resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "BackupVault" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Returns list of all available backup vaults.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults", +"httpMethod": "GET", +"id": "netapp.projects.locations.backupVaults.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "List filter.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of items to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The next_page_token value to use if there are additional results to retrieve for this list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The location for which to retrieve backupVault information, in the format `projects/{project_id}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/backupVaults", +"response": { +"$ref": "ListBackupVaultsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the settings of a specific backup vault.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", +"httpMethod": "PATCH", +"id": "netapp.projects.locations.backupVaults.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the Backup resource to be updated. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "BackupVault" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"backups": { +"methods": { +"create": { +"description": "Creates a backup from the volume specified in the request The backup can be created from the given snapshot if specified in the request. If no snapshot specified, there'll be a new snapshot taken to initiate the backup creation.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups", +"httpMethod": "POST", +"id": "netapp.projects.locations.backupVaults.backups.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"backupId": { +"description": "Required. The ID to use for the backup. The ID must be unique within the specified backupVault. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The NetApp backupVault to create the backups of, in the format `projects/*/locations/*/backupVaults/{backup_vault_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/backups", +"request": { +"$ref": "Backup" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Warning! This operation will permanently delete the backup.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups/{backupsId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.backupVaults.backups.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The backup resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/backups/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Returns the description of the specified backup", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups/{backupsId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.backupVaults.backups.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The backup resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/backups/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Backup" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Returns descriptions of all backups for a backupVault.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups", +"httpMethod": "GET", +"id": "netapp.projects.locations.backupVaults.backups.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "The standard list filter. If specified, backups will be returned based on the attribute name that matches the filter expression. If empty, then no backups are filtered out. See https://google.aip.dev/160", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of items to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The next_page_token value to use if there are additional results to retrieve for this list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The backupVault for which to retrieve backup information, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`. To retrieve backup information for all locations, use \"-\" for the `{location}` value. To retrieve backup information for all backupVaults, use \"-\" for the `{backup_vault_id}` value. To retrieve backup information for a volume, use \"-\" for the `{backup_vault_id}` value and specify volume full name with the filter.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/backups", +"response": { +"$ref": "ListBackupsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Update backup with full spec.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/backups/{backupsId}", +"httpMethod": "PATCH", +"id": "netapp.projects.locations.backupVaults.backups.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/backups/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the Backup resource to be updated. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "Backup" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"kmsConfigs": { +"methods": { +"create": { +"description": "Creates a new KMS config.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/kmsConfigs", +"httpMethod": "POST", +"id": "netapp.projects.locations.kmsConfigs.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"kmsConfigId": { +"description": "Required. Id of the requesting KmsConfig. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Value for parent.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/kmsConfigs", +"request": { +"$ref": "KmsConfig" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Warning! This operation will permanently delete the Kms config.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.kmsConfigs.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the KmsConfig.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"encrypt": { +"description": "Encrypt the existing volumes without CMEK encryption with the desired the KMS config for the whole region.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}:encrypt", +"httpMethod": "POST", +"id": "netapp.projects.locations.kmsConfigs.encrypt", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the KmsConfig.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:encrypt", +"request": { +"$ref": "EncryptVolumesRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Returns the description of the specified KMS config by kms_config_id.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.kmsConfigs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the KmsConfig", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "KmsConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Returns descriptions of all KMS configs owned by the caller.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/kmsConfigs", +"httpMethod": "GET", +"id": "netapp.projects.locations.kmsConfigs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "List filter.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of items to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The next_page_token value to use if there are additional results to retrieve for this list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/kmsConfigs", +"response": { +"$ref": "ListKmsConfigsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the Kms config properties with the full spec", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}", +"httpMethod": "PATCH", +"id": "netapp.projects.locations.kmsConfigs.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Name of the KmsConfig.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the KmsConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "KmsConfig" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"verify": { +"description": "Verifies KMS config reachability.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/kmsConfigs/{kmsConfigsId}:verify", +"httpMethod": "POST", +"id": "netapp.projects.locations.kmsConfigs.verify", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the KMS Config to be verified.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:verify", +"request": { +"$ref": "VerifyKmsConfigRequest" +}, +"response": { +"$ref": "VerifyKmsConfigResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "netapp.projects.locations.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"request": { +"$ref": "CancelOperationRequest" +}, +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations", +"httpMethod": "GET", +"id": "netapp.projects.locations.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "ListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"storagePools": { +"methods": { +"create": { +"description": "Creates a new storage pool.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools", +"httpMethod": "POST", +"id": "netapp.projects.locations.storagePools.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Value for parent.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"storagePoolId": { +"description": "Required. Id of the requesting storage pool. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+parent}/storagePools", +"request": { +"$ref": "StoragePool" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Warning! This operation will permanently delete the storage pool.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.storagePools.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the storage pool", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Returns the description of the specified storage pool by poolId.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.storagePools.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the storage pool", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "StoragePool" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Returns descriptions of all storage pools owned by the caller.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools", +"httpMethod": "GET", +"id": "netapp.projects.locations.storagePools.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. List filter.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of items to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value to use if there are additional results to retrieve for this list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/storagePools", +"response": { +"$ref": "ListStoragePoolsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the storage pool properties with the full spec", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}", +"httpMethod": "PATCH", +"id": "netapp.projects.locations.storagePools.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Name of the storage pool", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the StoragePool resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "StoragePool" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"switch": { +"description": "This operation will switch the active/replica zone for a regional storagePool.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:switch", +"httpMethod": "POST", +"id": "netapp.projects.locations.storagePools.switch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the storage pool", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:switch", +"request": { +"$ref": "SwitchActiveReplicaZoneRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"volumes": { +"methods": { +"create": { +"description": "Creates a new Volume in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes", +"httpMethod": "POST", +"id": "netapp.projects.locations.volumes.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Value for parent.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"volumeId": { +"description": "Required. Id of the requesting volume. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+parent}/volumes", +"request": { +"$ref": "Volume" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single Volume.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.volumes.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"force": { +"description": "If this field is set as true, CCFE will not block the volume resource deletion even if it has any snapshots resource. (Otherwise, the request will only work if the volume has no snapshots.)", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. Name of the volume", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single Volume.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.volumes.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the volume", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Volume" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Volumes in a given project.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes", +"httpMethod": "GET", +"id": "netapp.projects.locations.volumes.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Filtering results", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Hint for how to order the results", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListVolumesRequest", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/volumes", +"response": { +"$ref": "ListVolumesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of a single Volume.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}", +"httpMethod": "PATCH", +"id": "netapp.projects.locations.volumes.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Name of the volume", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the Volume resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "Volume" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"revert": { +"description": "Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:revert", +"httpMethod": "POST", +"id": "netapp.projects.locations.volumes.revert", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the volume, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:revert", +"request": { +"$ref": "RevertVolumeRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"replications": { +"methods": { +"create": { +"description": "Create a new replication for a volume.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications", +"httpMethod": "POST", +"id": "netapp.projects.locations.volumes.replications.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The NetApp volume to create the replications of, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +}, +"replicationId": { +"description": "Required. ID of the replication to create. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+parent}/replications", +"request": { +"$ref": "Replication" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a replication.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.volumes.replications.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The replication resource name, in the format `projects/*/locations/*/volumes/*/replications/{replication_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Describe a replication for a volume.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.volumes.replications.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The replication resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Replication" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Returns descriptions of all replications for a volume.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications", +"httpMethod": "GET", +"id": "netapp.projects.locations.volumes.replications.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "List filter.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of items to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The next_page_token value to use if there are additional results to retrieve for this list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The volume for which to retrieve replication information, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/replications", +"response": { +"$ref": "ListReplicationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the settings of a specific replication.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}", +"httpMethod": "PATCH", +"id": "netapp.projects.locations.volumes.replications.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Mask of fields to update. At least one path must be supplied in this field.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "Replication" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"resume": { +"description": "Resume Cross Region Replication.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}:resume", +"httpMethod": "POST", +"id": "netapp.projects.locations.volumes.replications.resume", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:resume", +"request": { +"$ref": "ResumeReplicationRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"reverseDirection": { +"description": "Reverses direction of replication. Source becomes destination and destination becomes source.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}:reverseDirection", +"httpMethod": "POST", +"id": "netapp.projects.locations.volumes.replications.reverseDirection", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:reverseDirection", +"request": { +"$ref": "ReverseReplicationDirectionRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"stop": { +"description": "Stop Cross Region Replication.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}:stop", +"httpMethod": "POST", +"id": "netapp.projects.locations.volumes.replications.stop", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/replications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:stop", +"request": { +"$ref": "StopReplicationRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"snapshots": { +"methods": { +"create": { +"description": "Create a new snapshot for a volume.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots", +"httpMethod": "POST", +"id": "netapp.projects.locations.volumes.snapshots.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The NetApp volume to create the snapshots of, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +}, +"snapshotId": { +"description": "Required. ID of the snapshot to create. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+parent}/snapshots", +"request": { +"$ref": "Snapshot" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a snapshot.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}", +"httpMethod": "DELETE", +"id": "netapp.projects.locations.volumes.snapshots.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The snapshot resource name, in the format `projects/*/locations/*/volumes/*/snapshots/{snapshot_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Describe a snapshot for a volume.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}", +"httpMethod": "GET", +"id": "netapp.projects.locations.volumes.snapshots.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The snapshot resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Snapshot" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Returns descriptions of all snapshots for a volume.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots", +"httpMethod": "GET", +"id": "netapp.projects.locations.volumes.snapshots.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "List filter.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of items to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The next_page_token value to use if there are additional results to retrieve for this list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The volume for which to retrieve snapshot information, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/snapshots", +"response": { +"$ref": "ListSnapshotsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the settings of a specific snapshot.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}", +"httpMethod": "PATCH", +"id": "netapp.projects.locations.volumes.snapshots.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the snapshot. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Mask of fields to update. At least one path must be supplied in this field.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "Snapshot" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +} +}, +"revision": "20241021", +"rootUrl": "https://netapp.googleapis.com/", +"schemas": { +"ActiveDirectory": { +"description": "ActiveDirectory is the public representation of the active directory config.", +"id": "ActiveDirectory", +"properties": { +"administrators": { +"description": "Optional. Users to be added to the Built-in Admininstrators group.", +"items": { +"type": "string" +}, +"type": "array" +}, +"aesEncryption": { +"description": "If enabled, AES encryption will be enabled for SMB communication.", +"type": "boolean" +}, +"backupOperators": { +"description": "Optional. Users to be added to the Built-in Backup Operator active directory group.", +"items": { +"type": "string" +}, +"type": "array" +}, +"createTime": { +"description": "Output only. Create time of the active directory.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Description of the active directory.", +"type": "string" +}, +"dns": { +"description": "Required. Comma separated list of DNS server IP addresses for the Active Directory domain.", +"type": "string" +}, +"domain": { +"description": "Required. Name of the Active Directory domain", +"type": "string" +}, +"encryptDcConnections": { +"description": "If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.", +"type": "boolean" +}, +"kdcHostname": { +"description": "Name of the active directory machine. This optional parameter is used only while creating kerberos volume", +"type": "string" +}, +"kdcIp": { +"description": "KDC server IP address for the active directory machine.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Labels for the active directory.", +"type": "object" +}, +"ldapSigning": { +"description": "Specifies whether or not the LDAP traffic needs to be signed.", +"type": "boolean" +}, +"name": { +"description": "Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.", +"type": "string" +}, +"netBiosPrefix": { +"description": "Required. NetBIOSPrefix is used as a prefix for SMB server name.", +"type": "string" +}, +"nfsUsersWithLdap": { +"description": "If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.", +"type": "boolean" +}, +"organizationalUnit": { +"description": "The Organizational Unit (OU) within the Windows Active Directory the user belongs to.", +"type": "string" +}, +"password": { +"description": "Required. Password of the Active Directory domain administrator.", +"type": "string" +}, +"securityOperators": { +"description": "Optional. Domain users to be given the SeSecurityPrivilege.", +"items": { +"type": "string" +}, +"type": "array" +}, +"site": { +"description": "The Active Directory site the service will limit Domain Controller discovery too.", +"type": "string" +}, +"state": { +"description": "Output only. The state of the AD.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"READY", +"UPDATING", +"IN_USE", +"DELETING", +"ERROR", +"DIAGNOSING" +], +"enumDescriptions": [ +"Unspecified Active Directory State", +"Active Directory State is Creating", +"Active Directory State is Ready", +"Active Directory State is Updating", +"Active Directory State is In use", +"Active Directory State is Deleting", +"Active Directory State is Error", +"Active Directory State is Diagnosing." +], +"readOnly": true, +"type": "string" +}, +"stateDetails": { +"description": "Output only. The state details of the Active Directory.", +"readOnly": true, +"type": "string" +}, +"username": { +"description": "Required. Username of the Active Directory domain administrator.", +"type": "string" +} +}, +"type": "object" +}, +"Backup": { +"description": "A NetApp Backup.", +"id": "Backup", +"properties": { +"backupType": { +"description": "Output only. Type of backup, manually created or created by a backup policy.", +"enum": [ +"TYPE_UNSPECIFIED", +"MANUAL", +"SCHEDULED" +], +"enumDescriptions": [ +"Unspecified backup type.", +"Manual backup type.", +"Scheduled backup type." +], +"readOnly": true, +"type": "string" +}, +"chainStorageBytes": { +"description": "Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time when the backup was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Resource labels to represent user provided metadata.", +"type": "object" +}, +"name": { +"description": "Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.", +"type": "string" +}, +"sourceSnapshot": { +"description": "If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`", +"type": "string" +}, +"sourceVolume": { +"description": "Volume full name of this backup belongs to. Format: `projects/{projects_id}/locations/{location}/volumes/{volume_id}`", +"type": "string" +}, +"state": { +"description": "Output only. The backup state.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"UPLOADING", +"READY", +"DELETING", +"ERROR", +"UPDATING" +], +"enumDescriptions": [ +"State not set.", +"Backup is being created. While in this state, the snapshot for the backup point-in-time may not have been created yet, and so the point-in-time may not have been fixed.", +"Backup is being uploaded. While in this state, none of the writes to the volume will be included in the backup.", +"Backup is available for use.", +"Backup is being deleted.", +"Backup is not valid and cannot be used for creating new volumes or restoring existing volumes.", +"Backup is being updated." +], +"readOnly": true, +"type": "string" +}, +"volumeUsageBytes": { +"description": "Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BackupConfig": { +"description": "BackupConfig contains backup related config on a volume.", +"id": "BackupConfig", +"properties": { +"backupChainBytes": { +"description": "Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"backupPolicies": { +"description": "Optional. When specified, schedule backups will be created based on the policy configuration.", +"items": { +"type": "string" +}, +"type": "array" +}, +"backupVault": { +"description": "Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}", +"type": "string" +}, +"scheduledBackupEnabled": { +"description": "Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.", +"type": "boolean" +} +}, +"type": "object" +}, +"BackupPolicy": { +"description": "Backup Policy.", +"id": "BackupPolicy", +"properties": { +"assignedVolumeCount": { +"description": "Output only. The total number of volumes assigned by this backup policy.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"createTime": { +"description": "Output only. The time when the backup policy was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dailyBackupLimit": { +"description": "Number of daily backups to keep. Note that the minimum daily backup limit is 2.", +"format": "int32", +"type": "integer" +}, +"description": { +"description": "Description of the backup policy.", +"type": "string" +}, +"enabled": { +"description": "If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.", +"type": "boolean" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Resource labels to represent user provided metadata.", +"type": "object" +}, +"monthlyBackupLimit": { +"description": "Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.", +"format": "int32", +"type": "integer" +}, +"name": { +"description": "Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.", +"type": "string" +}, +"state": { +"description": "Output only. The backup policy state.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"READY", +"DELETING", +"ERROR", +"UPDATING" +], +"enumDescriptions": [ +"State not set.", +"BackupPolicy is being created.", +"BackupPolicy is available for use.", +"BackupPolicy is being deleted.", +"BackupPolicy is not valid and cannot be used.", +"BackupPolicy is being updated." +], +"readOnly": true, +"type": "string" +}, +"weeklyBackupLimit": { +"description": "Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"BackupVault": { +"description": "A NetApp BackupVault.", +"id": "BackupVault", +"properties": { +"createTime": { +"description": "Output only. Create time of the backup vault.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Description of the backup vault.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Resource labels to represent user provided metadata.", +"type": "object" +}, +"name": { +"description": "Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.", +"type": "string" +}, +"state": { +"description": "Output only. The backup vault state.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"READY", +"DELETING", +"ERROR", +"UPDATING" +], +"enumDescriptions": [ +"State not set.", +"BackupVault is being created.", +"BackupVault is available for use.", +"BackupVault is being deleted.", +"BackupVault is not valid and cannot be used.", +"BackupVault is being updated." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CancelOperationRequest": { +"description": "The request message for Operations.CancelOperation.", +"id": "CancelOperationRequest", +"properties": {}, +"type": "object" +}, +"DailySchedule": { +"description": "Make a snapshot every day e.g. at 04:00, 05:20, 23:50", +"id": "DailySchedule", +"properties": { +"hour": { +"description": "Set the hour to start the snapshot (0-23), defaults to midnight (0).", +"format": "double", +"type": "number" +}, +"minute": { +"description": "Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).", +"format": "double", +"type": "number" +}, +"snapshotsToKeep": { +"description": "The maximum number of Snapshots to keep for the hourly schedule", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"DestinationVolumeParameters": { +"description": "DestinationVolumeParameters specify input parameters used for creating destination volume.", +"id": "DestinationVolumeParameters", +"properties": { +"description": { +"description": "Description for the destination volume.", +"type": "string" +}, +"shareName": { +"description": "Destination volume's share name. If not specified, source volume's share name will be used.", +"type": "string" +}, +"storagePool": { +"description": "Required. Existing destination StoragePool name.", +"type": "string" +}, +"volumeId": { +"description": "Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.", +"type": "string" +} +}, +"type": "object" +}, +"EncryptVolumesRequest": { +"description": "EncryptVolumesRequest specifies the KMS config to encrypt existing volumes.", +"id": "EncryptVolumesRequest", +"properties": {}, +"type": "object" +}, +"ExportPolicy": { +"description": "Defines the export policy for the volume.", +"id": "ExportPolicy", +"properties": { +"rules": { +"description": "Required. List of export policy rules", +"items": { +"$ref": "SimpleExportPolicyRule" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleProtobufEmpty": { +"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": "GoogleProtobufEmpty", +"properties": {}, +"type": "object" +}, +"HourlySchedule": { +"description": "Make a snapshot every hour e.g. at 04:00, 05:00, 06:00.", +"id": "HourlySchedule", +"properties": { +"minute": { +"description": "Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).", +"format": "double", +"type": "number" +}, +"snapshotsToKeep": { +"description": "The maximum number of Snapshots to keep for the hourly schedule", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"KmsConfig": { +"description": "KmsConfig is the customer managed encryption key(CMEK) configuration.", +"id": "KmsConfig", +"properties": { +"createTime": { +"description": "Output only. Create time of the KmsConfig.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"cryptoKeyName": { +"description": "Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.", +"type": "string" +}, +"description": { +"description": "Description of the KmsConfig.", +"type": "string" +}, +"instructions": { +"description": "Output only. Instructions to provide the access to the customer provided encryption key.", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Labels as key value pairs", +"type": "object" +}, +"name": { +"description": "Identifier. Name of the KmsConfig.", +"type": "string" +}, +"serviceAccount": { +"description": "Output only. The Service account which will have access to the customer provided encryption key.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. State of the KmsConfig.", +"enum": [ +"STATE_UNSPECIFIED", +"READY", +"CREATING", +"DELETING", +"UPDATING", +"IN_USE", +"ERROR", +"KEY_CHECK_PENDING", +"KEY_NOT_REACHABLE", +"DISABLING", +"DISABLED", +"MIGRATING" +], +"enumDescriptions": [ +"Unspecified KmsConfig State", +"KmsConfig State is Ready", +"KmsConfig State is Creating", +"KmsConfig State is Deleting", +"KmsConfig State is Updating", +"KmsConfig State is In Use.", +"KmsConfig State is Error", +"KmsConfig State is Pending to verify crypto key access.", +"KmsConfig State is Not accessbile by the SDE service account to the crypto key.", +"KmsConfig State is Disabling.", +"KmsConfig State is Disabled.", +"KmsConfig State is Migrating. The existing volumes are migrating from SMEK to CMEK." +], +"readOnly": true, +"type": "string" +}, +"stateDetails": { +"description": "Output only. State details of the KmsConfig.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ListActiveDirectoriesResponse": { +"description": "ListActiveDirectoriesResponse contains all the active directories requested.", +"id": "ListActiveDirectoriesResponse", +"properties": { +"activeDirectories": { +"description": "The list of active directories.", +"items": { +"$ref": "ActiveDirectory" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListBackupPoliciesResponse": { +"description": "ListBackupPoliciesResponse contains all the backup policies requested.", +"id": "ListBackupPoliciesResponse", +"properties": { +"backupPolicies": { +"description": "The list of backup policies.", +"items": { +"$ref": "BackupPolicy" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListBackupVaultsResponse": { +"description": "ListBackupVaultsResponse is the result of ListBackupVaultsRequest.", +"id": "ListBackupVaultsResponse", +"properties": { +"backupVaults": { +"description": "A list of backupVaults in the project for the specified location.", +"items": { +"$ref": "BackupVault" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListBackupsResponse": { +"description": "ListBackupsResponse is the result of ListBackupsRequest.", +"id": "ListBackupsResponse", +"properties": { +"backups": { +"description": "A list of backups in the project.", +"items": { +"$ref": "Backup" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListKmsConfigsResponse": { +"description": "ListKmsConfigsResponse is the response to a ListKmsConfigsRequest.", +"id": "ListKmsConfigsResponse", +"properties": { +"kmsConfigs": { +"description": "The list of KmsConfigs", +"items": { +"$ref": "KmsConfig" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListLocationsResponse": { +"description": "The response message for Locations.ListLocations.", +"id": "ListLocationsResponse", +"properties": { +"locations": { +"description": "A list of locations that matches the specified filter in the request.", +"items": { +"$ref": "Location" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +} +}, +"type": "object" +}, +"ListOperationsResponse": { +"description": "The response message for Operations.ListOperations.", +"id": "ListOperationsResponse", +"properties": { +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +}, +"operations": { +"description": "A list of operations that matches the specified filter in the request.", +"items": { +"$ref": "Operation" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListReplicationsResponse": { +"description": "ListReplicationsResponse is the result of ListReplicationsRequest.", +"id": "ListReplicationsResponse", +"properties": { +"nextPageToken": { +"description": "The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.", +"type": "string" +}, +"replications": { +"description": "A list of replications in the project for the specified volume.", +"items": { +"$ref": "Replication" +}, +"type": "array" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListSnapshotsResponse": { +"description": "ListSnapshotsResponse is the result of ListSnapshotsRequest.", +"id": "ListSnapshotsResponse", +"properties": { +"nextPageToken": { +"description": "The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.", +"type": "string" +}, +"snapshots": { +"description": "A list of snapshots in the project for the specified volume.", +"items": { +"$ref": "Snapshot" +}, +"type": "array" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListStoragePoolsResponse": { +"description": "ListStoragePoolsResponse is the response to a ListStoragePoolsRequest.", +"id": "ListStoragePoolsResponse", +"properties": { +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"storagePools": { +"description": "The list of StoragePools", +"items": { +"$ref": "StoragePool" +}, +"type": "array" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListVolumesResponse": { +"description": "Message for response to listing Volumes", +"id": "ListVolumesResponse", +"properties": { +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +}, +"volumes": { +"description": "The list of Volume", +"items": { +"$ref": "Volume" +}, +"type": "array" +} +}, +"type": "object" +}, +"Location": { +"description": "A resource that represents a Google Cloud location.", +"id": "Location", +"properties": { +"displayName": { +"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", +"type": "object" +}, +"locationId": { +"description": "The canonical id for this location. For example: `\"us-east1\"`.", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Service-specific metadata. For example the available capacity at the given location.", +"type": "object" +}, +"name": { +"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", +"type": "string" +} +}, +"type": "object" +}, +"LocationMetadata": { +"description": "Metadata for a given google.cloud.location.Location.", +"id": "LocationMetadata", +"properties": { +"supportedServiceLevels": { +"description": "Output only. Supported service levels in a location.", +"items": { +"enum": [ +"SERVICE_LEVEL_UNSPECIFIED", +"PREMIUM", +"EXTREME", +"STANDARD", +"FLEX" +], +"enumDescriptions": [ +"Unspecified service level.", +"Premium service level.", +"Extreme service level.", +"Standard service level.", +"Flex service level." +], +"type": "string" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"MonthlySchedule": { +"description": "Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50", +"id": "MonthlySchedule", +"properties": { +"daysOfMonth": { +"description": "Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.", +"type": "string" +}, +"hour": { +"description": "Set the hour to start the snapshot (0-23), defaults to midnight (0).", +"format": "double", +"type": "number" +}, +"minute": { +"description": "Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).", +"format": "double", +"type": "number" +}, +"snapshotsToKeep": { +"description": "The maximum number of Snapshots to keep for the hourly schedule", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"MountOption": { +"description": "View only mount options for a volume.", +"id": "MountOption", +"properties": { +"export": { +"description": "Export string", +"type": "string" +}, +"exportFull": { +"description": "Full export string", +"type": "string" +}, +"instructions": { +"description": "Instructions for mounting", +"type": "string" +}, +"protocol": { +"description": "Protocol to mount with.", +"enum": [ +"PROTOCOLS_UNSPECIFIED", +"NFSV3", +"NFSV4", +"SMB" +], +"enumDescriptions": [ +"Unspecified protocol", +"NFS V3 protocol", +"NFS V4 protocol", +"SMB protocol" +], +"type": "string" +} +}, +"type": "object" +}, +"Operation": { +"description": "This resource represents a long-running operation that is the result of a network API call.", +"id": "Operation", +"properties": { +"done": { +"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", +"type": "boolean" +}, +"error": { +"$ref": "Status", +"description": "The error result of the operation in case of failure or cancellation." +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", +"type": "object" +}, +"name": { +"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", +"type": "string" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", +"type": "object" +} +}, +"type": "object" +}, +"OperationMetadata": { +"description": "Represents the metadata of the long-running operation.", +"id": "OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been canceled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Replication": { +"description": "Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.", +"id": "Replication", +"properties": { +"createTime": { +"description": "Output only. Replication create time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "A description about this replication relationship.", +"type": "string" +}, +"destinationVolume": { +"description": "Output only. Full name of destination volume resource. Example : \"projects/{project}/locations/{location}/volumes/{volume_id}\"", +"readOnly": true, +"type": "string" +}, +"destinationVolumeParameters": { +"$ref": "DestinationVolumeParameters", +"description": "Required. Input only. Destination volume parameters" +}, +"healthy": { +"description": "Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.", +"readOnly": true, +"type": "boolean" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Resource labels to represent user provided metadata.", +"type": "object" +}, +"mirrorState": { +"description": "Output only. Indicates the state of mirroring.", +"enum": [ +"MIRROR_STATE_UNSPECIFIED", +"PREPARING", +"MIRRORED", +"STOPPED", +"TRANSFERRING" +], +"enumDescriptions": [ +"Unspecified MirrorState", +"Destination volume is being prepared.", +"Destination volume has been initialized and is ready to receive replication transfers.", +"Destination volume is not receiving replication transfers.", +"Incremental replication is in progress." +], +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.", +"type": "string" +}, +"replicationSchedule": { +"description": "Required. Indicates the schedule for replication.", +"enum": [ +"REPLICATION_SCHEDULE_UNSPECIFIED", +"EVERY_10_MINUTES", +"HOURLY", +"DAILY" +], +"enumDescriptions": [ +"Unspecified ReplicationSchedule", +"Replication happens once every 10 minutes.", +"Replication happens once every hour.", +"Replication happens once every day." +], +"type": "string" +}, +"role": { +"description": "Output only. Indicates whether this points to source or destination.", +"enum": [ +"REPLICATION_ROLE_UNSPECIFIED", +"SOURCE", +"DESTINATION" +], +"enumDescriptions": [ +"Unspecified replication role", +"Indicates Source volume.", +"Indicates Destination volume." +], +"readOnly": true, +"type": "string" +}, +"sourceVolume": { +"description": "Output only. Full name of source volume resource. Example : \"projects/{project}/locations/{location}/volumes/{volume_id}\"", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. State of the replication.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"READY", +"UPDATING", +"DELETING", +"ERROR" +], +"enumDescriptions": [ +"Unspecified replication State", +"Replication is creating.", +"Replication is ready.", +"Replication is updating.", +"Replication is deleting.", +"Replication is in error state." +], +"readOnly": true, +"type": "string" +}, +"stateDetails": { +"description": "Output only. State details of the replication.", +"readOnly": true, +"type": "string" +}, +"transferStats": { +"$ref": "TransferStats", +"description": "Output only. Replication transfer statistics.", +"readOnly": true +} +}, +"type": "object" +}, +"RestoreParameters": { +"description": "The RestoreParameters if volume is created from a snapshot or backup.", +"id": "RestoreParameters", +"properties": { +"sourceBackup": { +"description": "Full name of the backup resource. Format: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}", +"type": "string" +}, +"sourceSnapshot": { +"description": "Full name of the snapshot resource. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}", +"type": "string" +} +}, +"type": "object" +}, +"ResumeReplicationRequest": { +"description": "ResumeReplicationRequest resumes a stopped replication.", +"id": "ResumeReplicationRequest", +"properties": {}, +"type": "object" +}, +"ReverseReplicationDirectionRequest": { +"description": "ReverseReplicationDirectionRequest reverses direction of replication. Source becomes destination and destination becomes source.", +"id": "ReverseReplicationDirectionRequest", +"properties": {}, +"type": "object" +}, +"RevertVolumeRequest": { +"description": "RevertVolumeRequest reverts the given volume to the specified snapshot.", +"id": "RevertVolumeRequest", +"properties": { +"snapshotId": { +"description": "Required. The snapshot resource ID, in the format 'my-snapshot', where the specified ID is the {snapshot_id} of the fully qualified name like projects/{project_id}/locations/{location_id}/volumes/{volume_id}/snapshots/{snapshot_id}", +"type": "string" +} +}, +"type": "object" +}, +"SimpleExportPolicyRule": { +"description": "An export policy rule describing various export options.", +"id": "SimpleExportPolicyRule", +"properties": { +"accessType": { +"description": "Access type (ReadWrite, ReadOnly, None)", +"enum": [ +"ACCESS_TYPE_UNSPECIFIED", +"READ_ONLY", +"READ_WRITE", +"READ_NONE" +], +"enumDescriptions": [ +"Unspecified Access Type", +"Read Only", +"Read Write", +"None" +], +"type": "string" +}, +"allowedClients": { +"description": "Comma separated list of allowed clients IP addresses", +"type": "string" +}, +"hasRootAccess": { +"description": "Whether Unix root access will be granted.", +"type": "string" +}, +"kerberos5ReadOnly": { +"description": "If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.", +"type": "boolean" +}, +"kerberos5ReadWrite": { +"description": "If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled.", +"type": "boolean" +}, +"kerberos5iReadOnly": { +"description": "If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.", +"type": "boolean" +}, +"kerberos5iReadWrite": { +"description": "If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value be ignored if this is enabled.", +"type": "boolean" +}, +"kerberos5pReadOnly": { +"description": "If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.", +"type": "boolean" +}, +"kerberos5pReadWrite": { +"description": "If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value be ignored if this is enabled.", +"type": "boolean" +}, +"nfsv3": { +"description": "NFS V3 protocol.", +"type": "boolean" +}, +"nfsv4": { +"description": "NFS V4 protocol.", +"type": "boolean" +} +}, +"type": "object" +}, +"Snapshot": { +"description": "Snapshot is a point-in-time version of a Volume's content.", +"id": "Snapshot", +"properties": { +"createTime": { +"description": "Output only. The time when the snapshot was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Resource labels to represent user provided metadata.", +"type": "object" +}, +"name": { +"description": "Identifier. The resource name of the snapshot. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`.", +"type": "string" +}, +"state": { +"description": "Output only. The snapshot state.", +"enum": [ +"STATE_UNSPECIFIED", +"READY", +"CREATING", +"DELETING", +"UPDATING", +"DISABLED", +"ERROR" +], +"enumDescriptions": [ +"Unspecified Snapshot State", +"Snapshot State is Ready", +"Snapshot State is Creating", +"Snapshot State is Deleting", +"Snapshot State is Updating", +"Snapshot State is Disabled", +"Snapshot State is Error" +], +"readOnly": true, +"type": "string" +}, +"stateDetails": { +"description": "Output only. State details of the storage pool", +"readOnly": true, +"type": "string" +}, +"usedBytes": { +"description": "Output only. Current storage usage for the snapshot in bytes.", +"format": "double", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, +"SnapshotPolicy": { +"description": "Snapshot Policy for a volume.", +"id": "SnapshotPolicy", +"properties": { +"dailySchedule": { +"$ref": "DailySchedule", +"description": "Daily schedule policy." +}, +"enabled": { +"description": "If enabled, make snapshots automatically according to the schedules. Default is false.", +"type": "boolean" +}, +"hourlySchedule": { +"$ref": "HourlySchedule", +"description": "Hourly schedule policy." +}, +"monthlySchedule": { +"$ref": "MonthlySchedule", +"description": "Monthly schedule policy." +}, +"weeklySchedule": { +"$ref": "WeeklySchedule", +"description": "Weekly schedule policy." +} +}, +"type": "object" +}, +"Status": { +"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", +"id": "Status", +"properties": { +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", +"format": "int32", +"type": "integer" +}, +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", +"type": "string" +} +}, +"type": "object" +}, +"StopReplicationRequest": { +"description": "StopReplicationRequest stops a replication until resumed.", +"id": "StopReplicationRequest", +"properties": { +"force": { +"description": "Indicates whether to stop replication forcefully while data transfer is in progress. Warning! if force is true, this will abort any current transfers and can lead to data loss due to partial transfer. If force is false, stop replication will fail while data transfer is in progress and you will need to retry later.", +"type": "boolean" +} +}, +"type": "object" +}, +"StoragePool": { +"description": "StoragePool is a container for volumes with a service level and capacity. Volumes can be created in a pool of sufficient available capacity. StoragePool capacity is what you are billed for.", +"id": "StoragePool", +"properties": { +"activeDirectory": { +"description": "Optional. Specifies the Active Directory to be used for creating a SMB volume.", +"type": "string" +}, +"allowAutoTiering": { +"description": "Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.", +"type": "boolean" +}, +"capacityGib": { +"description": "Required. Capacity in GIB of the pool", +"format": "int64", +"type": "string" +}, +"createTime": { +"description": "Output only. Create time of the storage pool", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. Description of the storage pool", +"type": "string" +}, +"encryptionType": { +"description": "Output only. Specifies the current pool encryption key source.", +"enum": [ +"ENCRYPTION_TYPE_UNSPECIFIED", +"SERVICE_MANAGED", +"CLOUD_KMS" +], +"enumDescriptions": [ +"The source of the encryption key is not specified.", +"Google managed encryption key.", +"Customer managed encryption key, which is stored in KMS." +], +"readOnly": true, +"type": "string" +}, +"globalAccessAllowed": { +"deprecated": true, +"description": "Deprecated. Used to allow SO pool to access AD or DNS server from other regions.", +"type": "boolean" +}, +"kmsConfig": { +"description": "Optional. Specifies the KMS config to be used for volume encryption.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels as key value pairs", +"type": "object" +}, +"ldapEnabled": { +"description": "Optional. Flag indicating if the pool is NFS LDAP enabled or not.", +"type": "boolean" +}, +"name": { +"description": "Identifier. Name of the storage pool", +"type": "string" +}, +"network": { +"description": "Required. VPC Network name. Format: projects/{project}/global/networks/{network}", +"type": "string" +}, +"psaRange": { +"description": "Optional. This field is not implemented. The values provided in this field are ignored.", +"type": "string" +}, +"replicaZone": { +"description": "Optional. Specifies the replica zone for regional storagePool.", +"type": "string" +}, +"serviceLevel": { +"description": "Required. Service level of the storage pool", +"enum": [ +"SERVICE_LEVEL_UNSPECIFIED", +"PREMIUM", +"EXTREME", +"STANDARD", +"FLEX" +], +"enumDescriptions": [ +"Unspecified service level.", +"Premium service level.", +"Extreme service level.", +"Standard service level.", +"Flex service level." +], +"type": "string" +}, +"state": { +"description": "Output only. State of the storage pool", +"enum": [ +"STATE_UNSPECIFIED", +"READY", +"CREATING", +"DELETING", +"UPDATING", +"RESTORING", +"DISABLED", +"ERROR" +], +"enumDescriptions": [ +"Unspecified Storage Pool State", +"Storage Pool State is Ready", +"Storage Pool State is Creating", +"Storage Pool State is Deleting", +"Storage Pool State is Updating", +"Storage Pool State is Restoring", +"Storage Pool State is Disabled", +"Storage Pool State is Error" +], +"readOnly": true, +"type": "string" +}, +"stateDetails": { +"description": "Output only. State details of the storage pool", +"readOnly": true, +"type": "string" +}, +"volumeCapacityGib": { +"description": "Output only. Allocated size of all volumes in GIB in the storage pool", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"volumeCount": { +"description": "Output only. Volume count of the storage pool", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"zone": { +"description": "Optional. Specifies the active zone for regional storagePool.", +"type": "string" +} +}, +"type": "object" +}, +"SwitchActiveReplicaZoneRequest": { +"description": "SwitchActiveReplicaZoneRequest switch the active/replica zone for a regional storagePool.", +"id": "SwitchActiveReplicaZoneRequest", +"properties": {}, +"type": "object" +}, +"TieringPolicy": { +"description": "Defines tiering policy for the volume.", +"id": "TieringPolicy", +"properties": { +"coolingThresholdDays": { +"description": "Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31.", +"format": "int32", +"type": "integer" +}, +"tierAction": { +"description": "Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.", +"enum": [ +"TIER_ACTION_UNSPECIFIED", +"ENABLED", +"PAUSED" +], +"enumDescriptions": [ +"Unspecified.", +"When tiering is enabled, new cold data will be tiered.", +"When paused, tiering won't be performed on new data. Existing data stays tiered until accessed." +], +"type": "string" +} +}, +"type": "object" +}, +"TransferStats": { +"description": "TransferStats reports all statistics related to replication transfer.", +"id": "TransferStats", +"properties": { +"lagDuration": { +"description": "Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.", +"format": "google-duration", +"type": "string" +}, +"lastTransferBytes": { +"description": "Last transfer size in bytes.", +"format": "int64", +"type": "string" +}, +"lastTransferDuration": { +"description": "Time taken during last transfer.", +"format": "google-duration", +"type": "string" +}, +"lastTransferEndTime": { +"description": "Time when last transfer completed.", +"format": "google-datetime", +"type": "string" +}, +"lastTransferError": { +"description": "A message describing the cause of the last transfer failure.", +"type": "string" +}, +"totalTransferDuration": { +"description": "Cumulative time taken across all transfers for the replication relationship.", +"format": "google-duration", +"type": "string" +}, +"transferBytes": { +"description": "Cumulative bytes trasferred so far for the replication relatinonship.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Time when progress was updated last.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"VerifyKmsConfigRequest": { +"description": "VerifyKmsConfigRequest specifies the KMS config to be validated.", +"id": "VerifyKmsConfigRequest", +"properties": {}, +"type": "object" +}, +"VerifyKmsConfigResponse": { +"description": "VerifyKmsConfigResponse contains the information if the config is correctly and error message.", +"id": "VerifyKmsConfigResponse", +"properties": { +"healthError": { +"description": "Output only. Error message if config is not healthy.", +"readOnly": true, +"type": "string" +}, +"healthy": { +"description": "Output only. If the customer key configured correctly to the encrypt volume.", +"readOnly": true, +"type": "boolean" +}, +"instructions": { +"description": "Output only. Instructions for the customers to provide the access to the encryption key.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Volume": { +"description": "Volume provides a filesystem that you can mount.", +"id": "Volume", +"properties": { +"activeDirectory": { +"description": "Output only. Specifies the ActiveDirectory name of a SMB volume.", +"readOnly": true, +"type": "string" +}, +"backupConfig": { +"$ref": "BackupConfig", +"description": "BackupConfig of the volume." +}, +"capacityGib": { +"description": "Required. Capacity in GIB of the volume", +"format": "int64", +"type": "string" +}, +"coldTierSizeGib": { +"description": "Output only. Size of the volume cold tier data in GiB.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. Create time of the volume", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. Description of the volume", +"type": "string" +}, +"encryptionType": { +"description": "Output only. Specified the current volume encryption key source.", +"enum": [ +"ENCRYPTION_TYPE_UNSPECIFIED", +"SERVICE_MANAGED", +"CLOUD_KMS" +], +"enumDescriptions": [ +"The source of the encryption key is not specified.", +"Google managed encryption key.", +"Customer managed encryption key, which is stored in KMS." +], +"readOnly": true, +"type": "string" +}, +"exportPolicy": { +"$ref": "ExportPolicy", +"description": "Optional. Export policy of the volume" +}, +"hasReplication": { +"description": "Output only. Indicates whether the volume is part of a replication relationship.", +"readOnly": true, +"type": "boolean" +}, +"kerberosEnabled": { +"description": "Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).", +"type": "boolean" +}, +"kmsConfig": { +"description": "Output only. Specifies the KMS config to be used for volume encryption.", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels as key value pairs", +"type": "object" +}, +"largeCapacity": { +"description": "Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.", +"type": "boolean" +}, +"ldapEnabled": { +"description": "Output only. Flag indicating if the volume is NFS LDAP enabled or not.", +"readOnly": true, +"type": "boolean" +}, +"mountOptions": { +"description": "Output only. Mount options of this volume", +"items": { +"$ref": "MountOption" +}, +"readOnly": true, +"type": "array" +}, +"multipleEndpoints": { +"description": "Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.", +"type": "boolean" +}, +"name": { +"description": "Identifier. Name of the volume", +"type": "string" +}, +"network": { +"description": "Output only. VPC Network name. Format: projects/{project}/global/networks/{network}", +"readOnly": true, +"type": "string" +}, +"protocols": { +"description": "Required. Protocols required for the volume", +"items": { +"enum": [ +"PROTOCOLS_UNSPECIFIED", +"NFSV3", +"NFSV4", +"SMB" +], +"enumDescriptions": [ +"Unspecified protocol", +"NFS V3 protocol", +"NFS V4 protocol", +"SMB protocol" +], +"type": "string" +}, +"type": "array" +}, +"psaRange": { +"description": "Output only. This field is not implemented. The values provided in this field are ignored.", +"readOnly": true, +"type": "string" +}, +"replicaZone": { +"description": "Output only. Specifies the replica zone for regional volume.", +"readOnly": true, +"type": "string" +}, +"restoreParameters": { +"$ref": "RestoreParameters", +"description": "Optional. Specifies the source of the volume to be created from." +}, +"restrictedActions": { +"description": "Optional. List of actions that are restricted on this volume.", +"items": { +"enum": [ +"RESTRICTED_ACTION_UNSPECIFIED", +"DELETE" +], +"enumDescriptions": [ +"Unspecified restricted action", +"Prevent volume from being deleted when mounted." +], +"type": "string" +}, +"type": "array" +}, +"securityStyle": { +"description": "Optional. Security Style of the Volume", +"enum": [ +"SECURITY_STYLE_UNSPECIFIED", +"NTFS", +"UNIX" +], +"enumDescriptions": [ +"SecurityStyle is unspecified", +"SecurityStyle uses NTFS", +"SecurityStyle uses UNIX" +], +"type": "string" +}, +"serviceLevel": { +"description": "Output only. Service level of the volume", +"enum": [ +"SERVICE_LEVEL_UNSPECIFIED", +"PREMIUM", +"EXTREME", +"STANDARD", +"FLEX" +], +"enumDescriptions": [ +"Unspecified service level.", +"Premium service level.", +"Extreme service level.", +"Standard service level.", +"Flex service level." +], +"readOnly": true, +"type": "string" +}, +"shareName": { +"description": "Required. Share name of the volume", +"type": "string" +}, +"smbSettings": { +"description": "Optional. SMB share settings for the volume.", +"items": { +"enum": [ +"SMB_SETTINGS_UNSPECIFIED", +"ENCRYPT_DATA", +"BROWSABLE", +"CHANGE_NOTIFY", +"NON_BROWSABLE", +"OPLOCKS", +"SHOW_SNAPSHOT", +"SHOW_PREVIOUS_VERSIONS", +"ACCESS_BASED_ENUMERATION", +"CONTINUOUSLY_AVAILABLE" +], +"enumDescriptions": [ +"Unspecified default option", +"SMB setting encrypt data", +"SMB setting browsable", +"SMB setting notify change", +"SMB setting not to notify change", +"SMB setting oplocks", +"SMB setting to show snapshots", +"SMB setting to show previous versions", +"SMB setting to access volume based on enumerartion", +"Continuously available enumeration" +], +"type": "string" +}, +"type": "array" +}, +"snapReserve": { +"description": "Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.", +"format": "double", +"type": "number" +}, +"snapshotDirectory": { +"description": "Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.", +"type": "boolean" +}, +"snapshotPolicy": { +"$ref": "SnapshotPolicy", +"description": "Optional. SnapshotPolicy for a volume." +}, +"state": { +"description": "Output only. State of the volume", +"enum": [ +"STATE_UNSPECIFIED", +"READY", +"CREATING", +"DELETING", +"UPDATING", +"RESTORING", +"DISABLED", +"ERROR" +], +"enumDescriptions": [ +"Unspecified Volume State", +"Volume State is Ready", +"Volume State is Creating", +"Volume State is Deleting", +"Volume State is Updating", +"Volume State is Restoring", +"Volume State is Disabled", +"Volume State is Error" +], +"readOnly": true, +"type": "string" +}, +"stateDetails": { +"description": "Output only. State details of the volume", +"readOnly": true, +"type": "string" +}, +"storagePool": { +"description": "Required. StoragePool name of the volume", +"type": "string" +}, +"tieringPolicy": { +"$ref": "TieringPolicy", +"description": "Tiering policy for the volume." +}, +"unixPermissions": { +"description": "Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.", +"type": "string" +}, +"usedGib": { +"description": "Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"zone": { +"description": "Output only. Specifies the active zone for regional volume.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"WeeklySchedule": { +"description": "Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50", +"id": "WeeklySchedule", +"properties": { +"day": { +"description": "Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.", +"type": "string" +}, +"hour": { +"description": "Set the hour to start the snapshot (0-23), defaults to midnight (0).", +"format": "double", +"type": "number" +}, +"minute": { +"description": "Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).", +"format": "double", +"type": "number" +}, +"snapshotsToKeep": { +"description": "The maximum number of Snapshots to keep for the hourly schedule", +"format": "double", +"type": "number" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "NetApp API", +"version": "v1beta1", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json index edd7d89341..c1cbd77387 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json @@ -2812,7 +2812,7 @@ } } }, -"revision": "20240923", +"revision": "20241009", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -2937,6 +2937,20 @@ "description": "This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.", "type": "boolean" }, +"ipVersion": { +"description": "The requested IP version for the PSC connection.", +"enum": [ +"IP_VERSION_UNSPECIFIED", +"IPV4", +"IPV6" +], +"enumDescriptions": [ +"Default value. We will use IPv4 or IPv6 depending on the IP version of first available subnetwork.", +"Will use IPv4 only.", +"Will use IPv6 only." +], +"type": "string" +}, "network": { "description": "The resource path of the consumer network where PSC connections are allowed to be created in. Note, this network does not need be in the ConsumerPscConfig.project in the case of SharedVPC. Example: projects/{projectNumOrId}/global/networks/{networkId}.", "type": "string" @@ -3030,6 +3044,20 @@ "description": "The IP literal allocated on the consumer network for the PSC forwarding rule that is created to connect to the producer service attachment in this service connection map.", "type": "string" }, +"ipVersion": { +"description": "The requested IP version for the PSC connection.", +"enum": [ +"IP_VERSION_UNSPECIFIED", +"IPV4", +"IPV6" +], +"enumDescriptions": [ +"Default value. We will use IPv4 or IPv6 depending on the IP version of first available subnetwork.", +"Will use IPv4 only.", +"Will use IPv6 only." +], +"type": "string" +}, "network": { "description": "The consumer network whose PSC forwarding rule is connected to the service attachments in this service connection map. Note that the network could be on a different project (shared VPC).", "type": "string" @@ -3070,14 +3098,18 @@ "ACTIVE", "FAILED", "CREATING", -"DELETING" +"DELETING", +"CREATE_REPAIRING", +"DELETE_REPAIRING" ], "enumDescriptions": [ "An invalid state as the default case.", "The connection has been created successfully. However, for the up-to-date connection status, please use the service attachment's \"ConnectedEndpoint.status\" as the source of truth.", "The connection is not functional since some resources on the connection fail to be created.", "The connection is being created.", -"The connection is being deleted." +"The connection is being deleted.", +"The connection is being repaired to complete creation.", +"The connection is being repaired to complete deletion." ], "type": "string" } @@ -3480,7 +3512,7 @@ }, "migration": { "$ref": "Migration", -"description": "Optional. Should be present if usage is set to FOR_MIGRATION." +"description": "Optional. Must be present if usage is set to FOR_MIGRATION. This field is for internal use." }, "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", @@ -3552,7 +3584,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." +"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." ], "type": "string" }, @@ -4465,6 +4497,20 @@ "description": "The last Compute Engine operation to setup PSC connection.", "type": "string" }, +"ipVersion": { +"description": "The requested IP version for the PSC connection.", +"enum": [ +"IP_VERSION_UNSPECIFIED", +"IPV4", +"IPV6" +], +"enumDescriptions": [ +"Default value. We will use IPv4 or IPv6 depending on the IP version of first available subnetwork.", +"Will use IPv4 only.", +"Will use IPv6 only." +], +"type": "string" +}, "producerInstanceId": { "deprecated": true, "description": "Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance.", @@ -4498,14 +4544,18 @@ "ACTIVE", "FAILED", "CREATING", -"DELETING" +"DELETING", +"CREATE_REPAIRING", +"DELETE_REPAIRING" ], "enumDescriptions": [ "An invalid state as the default case.", "The connection has been created successfully. However, for the up-to-date connection status, please use the created forwarding rule's \"PscConnectionStatus\" as the source of truth.", "The connection is not functional since some resources on the connection fail to be created.", "The connection is being created.", -"The connection is being deleted." +"The connection is being deleted.", +"The connection is being repaired to complete creation.", +"The connection is being repaired to complete deletion." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json index fea81e066b..57b6c58cc7 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json @@ -1116,7 +1116,7 @@ } } }, -"revision": "20240911", +"revision": "20241009", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AuditConfig": { @@ -1395,7 +1395,7 @@ }, "migration": { "$ref": "Migration", -"description": "Optional. Should be present if usage is set to FOR_MIGRATION." +"description": "Optional. Must be present if usage is set to FOR_MIGRATION. This field is for internal use." }, "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", @@ -1467,7 +1467,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." +"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." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index fe0b57fd10..d59672d3d8 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -591,7 +591,7 @@ } } }, -"revision": "20240918", +"revision": "20241016", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -616,6 +616,7 @@ "PERMISSION_DENIED", "PERMISSION_DENIED_NO_CLOUD_NAT_CONFIGS", "PERMISSION_DENIED_NO_NEG_ENDPOINT_CONFIGS", +"PERMISSION_DENIED_NO_CLOUD_ROUTER_CONFIGS", "NO_SOURCE_LOCATION", "INVALID_ARGUMENT", "TRACE_TOO_LONG", @@ -672,6 +673,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -690,6 +692,7 @@ false "Aborted because user lacks permission to access all or part of the network configurations required to run the test.", "Aborted because user lacks permission to access Cloud NAT configs required to run the test.", "Aborted because user lacks permission to access Network endpoint group endpoint configs required to run the test.", +"Aborted because user lacks permission to access Cloud Router configs required to run the test.", "Aborted because no valid source or destination endpoint is derived from the input test request.", "Aborted because the source or destination endpoint specified in the request is invalid. Some examples: - The request might contain malformed resource URI, project ID, or IP address. - The request might contain inconsistent information (for example, the request might include both the instance and the network, but the instance might not have a NIC in that network).", "Aborted because the number of steps in the trace exceeds a certain limit. It might be caused by a routing loop.", @@ -1238,7 +1241,7 @@ false "Packet sent to a load balancer, which requires a proxy-only subnet and the subnet is not found.", "Packet sent to Cloud Nat without active NAT IPs.", "Packet is stuck in a routing loop.", -"Packet is dropped due to an unspecified reason inside a Google-managed service. Used only for return traces.", +"Packet is dropped inside a Google-managed service due to being delivered in return trace to an endpoint that doesn't match the endpoint the packet was sent from in forward trace. Used only for return traces.", "Packet is dropped due to a load balancer backend instance not having a network interface in the network expected by the load balancer.", "Packet is dropped due to a backend service named port not being defined on the instance group level.", "Packet is dropped due to a destination IP range being part of a Private NAT IP range.", diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index c227a6294b..950fed5130 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -758,7 +758,7 @@ } } }, -"revision": "20240918", +"revision": "20241016", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -783,6 +783,7 @@ "PERMISSION_DENIED", "PERMISSION_DENIED_NO_CLOUD_NAT_CONFIGS", "PERMISSION_DENIED_NO_NEG_ENDPOINT_CONFIGS", +"PERMISSION_DENIED_NO_CLOUD_ROUTER_CONFIGS", "NO_SOURCE_LOCATION", "INVALID_ARGUMENT", "TRACE_TOO_LONG", @@ -839,6 +840,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -857,6 +859,7 @@ false "Aborted because user lacks permission to access all or part of the network configurations required to run the test.", "Aborted because user lacks permission to access Cloud NAT configs required to run the test.", "Aborted because user lacks permission to access Network endpoint group endpoint configs required to run the test.", +"Aborted because user lacks permission to access Cloud Router configs required to run the test.", "Aborted because no valid source or destination endpoint is derived from the input test request.", "Aborted because the source or destination endpoint specified in the request is invalid. Some examples: - The request might contain malformed resource URI, project ID, or IP address. - The request might contain inconsistent information (for example, the request might include both the instance and the network, but the instance might not have a NIC in that network).", "Aborted because the number of steps in the trace exceeds a certain limit. It might be caused by a routing loop.", @@ -1066,11 +1069,6 @@ false "description": "Location in which this revision is deployed.", "type": "string" }, -"serviceName": { -"deprecated": true, -"description": "ID of Cloud Run Service this revision belongs to. Was never set, is not exported to v1 proto and public protos. Do not export to v1beta1 public proto.", -"type": "string" -}, "serviceUri": { "description": "URI of Cloud Run service this revision belongs to.", "type": "string" @@ -1410,7 +1408,7 @@ false "Packet sent to a load balancer, which requires a proxy-only subnet and the subnet is not found.", "Packet sent to Cloud Nat without active NAT IPs.", "Packet is stuck in a routing loop.", -"Packet is dropped due to an unspecified reason inside a Google-managed service. Used only for return traces.", +"Packet is dropped inside a Google-managed service due to being delivered in return trace to an endpoint that doesn't match the endpoint the packet was sent from in forward trace. Used only for return traces.", "Packet is dropped due to a load balancer backend instance not having a network interface in the network expected by the load balancer.", "Packet is dropped due to a backend service named port not being defined on the instance group level.", "Packet is dropped due to a destination IP range being part of a Private NAT IP range.", @@ -3334,6 +3332,21 @@ false ], "type": "string" }, +"targetResourceState": { +"description": "Output only. A diagnostic bit - describes the state of the configured target resource for diagnostic purposes.", +"enum": [ +"TARGET_RESOURCE_STATE_UNSPECIFIED", +"TARGET_RESOURCE_EXISTS", +"TARGET_RESOURCE_DOES_NOT_EXIST" +], +"enumDescriptions": [ +"Unspecified target resource state.", +"Indicates that the target resource exists.", +"Indicates that the target resource does not exist." +], +"readOnly": true, +"type": "string" +}, "updateTime": { "description": "Output only. The time the config was updated.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1.json b/googleapiclient/discovery_cache/documents/networkservices.v1.json index 61ded6a292..f93d7e50e6 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1.json @@ -1976,7 +1976,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`.", +"description": "Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/serviceLbPolicies/[^/]+$", "required": true, @@ -2315,13 +2315,310 @@ ] } } +}, +"wasmPlugins": { +"methods": { +"create": { +"description": "Creates a new `WasmPlugin` resource in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/wasmPlugins", +"httpMethod": "POST", +"id": "networkservices.projects.locations.wasmPlugins.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource of the `WasmPlugin` resource. Must be in the format `projects/{project}/locations/global`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"wasmPluginId": { +"description": "Required. User-provided ID of the `WasmPlugin` resource to be created.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/wasmPlugins", +"request": { +"$ref": "WasmPlugin" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes the specified `WasmPlugin` resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/wasmPlugins/{wasmPluginsId}", +"httpMethod": "DELETE", +"id": "networkservices.projects.locations.wasmPlugins.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. A name of the `WasmPlugin` resource to delete. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/wasmPlugins/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of the specified `WasmPlugin` resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/wasmPlugins/{wasmPluginsId}", +"httpMethod": "GET", +"id": "networkservices.projects.locations.wasmPlugins.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. A name of the `WasmPlugin` resource to get. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/wasmPlugins/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Determine how much data should be returned by the API. See [AIP-157](https://google.aip.dev/157).", +"enum": [ +"WASM_PLUGIN_VIEW_UNSPECIFIED", +"WASM_PLUGIN_VIEW_BASIC", +"WASM_PLUGIN_VIEW_FULL" +], +"enumDescriptions": [ +"The default / unset value. The API will default to the BASIC view.", +"Include just WasmPlugin record.", +"Include WasmPlugin record and all its WasmPluginVersions." +], +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "WasmPlugin" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists `WasmPlugin` resources in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/wasmPlugins", +"httpMethod": "GET", +"id": "networkservices.projects.locations.wasmPlugins.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of `WasmPlugin` resources to return per call. If not specified, at most 50 `WasmPlugin`s are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The value returned by the last `ListWasmPluginsResponse` call. Indicates that this is a continuation of a prior `ListWasmPlugins` call, and that the next page of data is to be returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project and location from which the `WasmPlugin` resources are listed, specified in the following format: `projects/{project}/locations/global`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/wasmPlugins", +"response": { +"$ref": "ListWasmPluginsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of the specified `WasmPlugin` resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/wasmPlugins/{wasmPluginsId}", +"httpMethod": "PATCH", +"id": "networkservices.projects.locations.wasmPlugins.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Name of the `WasmPlugin` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/wasmPlugins/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Used to specify the fields to be overwritten in the `WasmPlugin` resource by the update. The fields specified in the `update_mask` field are relative to the resource, not the full request. An omitted `update_mask` field is treated as an implied `update_mask` field equivalent to all fields that are populated (that have a non-empty value). The `update_mask` field supports a special value `*`, which means that each field in the given `WasmPlugin` resource (including the empty ones) replaces the current value.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "WasmPlugin" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"versions": { +"methods": { +"create": { +"description": "Creates a new `WasmPluginVersion` resource in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/wasmPlugins/{wasmPluginsId}/versions", +"httpMethod": "POST", +"id": "networkservices.projects.locations.wasmPlugins.versions.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource of the `WasmPluginVersion` resource. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/wasmPlugins/[^/]+$", +"required": true, +"type": "string" +}, +"wasmPluginVersionId": { +"description": "Required. User-provided ID of the `WasmPluginVersion` resource to be created.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/versions", +"request": { +"$ref": "WasmPluginVersion" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes the specified `WasmPluginVersion` resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/wasmPlugins/{wasmPluginsId}/versions/{versionsId}", +"httpMethod": "DELETE", +"id": "networkservices.projects.locations.wasmPlugins.versions.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. A name of the `WasmPluginVersion` resource to delete. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}/versions/{wasm_plugin_version}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/wasmPlugins/[^/]+/versions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of the specified `WasmPluginVersion` resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/wasmPlugins/{wasmPluginsId}/versions/{versionsId}", +"httpMethod": "GET", +"id": "networkservices.projects.locations.wasmPlugins.versions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. A name of the `WasmPluginVersion` resource to get. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}/versions/{wasm_plugin_version}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/wasmPlugins/[^/]+/versions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "WasmPluginVersion" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists `WasmPluginVersion` resources in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/wasmPlugins/{wasmPluginsId}/versions", +"httpMethod": "GET", +"id": "networkservices.projects.locations.wasmPlugins.versions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of `WasmPluginVersion` resources to return per call. If not specified, at most 50 `WasmPluginVersion`s are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The value returned by the last `ListWasmPluginVersionsResponse` call. Indicates that this is a continuation of a prior `ListWasmPluginVersions` call, and that the next page of data is to be returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The `WasmPlugin` resource whose `WasmPluginVersion`s are listed, specified in the following format: `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/wasmPlugins/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/versions", +"response": { +"$ref": "ListWasmPluginVersionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} } } } } } }, -"revision": "20240919", +"revision": "20241010", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -2578,7 +2875,7 @@ "id": "ExtensionChainExtension", "properties": { "authority": { -"description": "Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions.", +"description": "Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions and must not be set.", "type": "string" }, "failOpen": { @@ -2592,12 +2889,20 @@ }, "type": "array" }, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set.", +"type": "object" +}, "name": { "description": "Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.", "type": "string" }, "service": { -"description": "Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`.", +"description": "Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, this must be a reference to a [wasm plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`.", "type": "string" }, "supportedEvents": { @@ -2626,7 +2931,7 @@ "type": "array" }, "timeout": { -"description": "Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions.", +"description": "Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for callout extensions. This field is not supported for plugin extensions and must not be set.", "format": "google-duration", "type": "string" } @@ -3690,7 +3995,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name.", +"description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set.", "type": "object" }, "name": { @@ -3760,7 +4065,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name.", +"description": "Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set.", "type": "object" }, "name": { @@ -4031,6 +4336,42 @@ }, "type": "object" }, +"ListWasmPluginVersionsResponse": { +"description": "Response returned by the `ListWasmPluginVersions` method.", +"id": "ListWasmPluginVersionsResponse", +"properties": { +"nextPageToken": { +"description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", +"type": "string" +}, +"wasmPluginVersions": { +"description": "List of `WasmPluginVersion` resources.", +"items": { +"$ref": "WasmPluginVersion" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListWasmPluginsResponse": { +"description": "Response returned by the `ListWasmPlugins` method.", +"id": "ListWasmPluginsResponse", +"properties": { +"nextPageToken": { +"description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", +"type": "string" +}, +"wasmPlugins": { +"description": "List of `WasmPlugin` resources.", +"items": { +"$ref": "WasmPlugin" +}, +"type": "array" +} +}, +"type": "object" +}, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", @@ -4369,7 +4710,7 @@ "type": "string" }, "name": { -"description": "Required. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`.", +"description": "Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`.", "type": "string" }, "updateTime": { @@ -4754,6 +5095,223 @@ } }, "type": "object" +}, +"WasmPlugin": { +"description": "`WasmPlugin` is a resource representing a service executing a customer-provided Wasm module.", +"id": "WasmPlugin", +"properties": { +"createTime": { +"description": "Output only. The timestamp when the resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. A human-readable description of the resource.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Set of labels associated with the `WasmPlugin` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).", +"type": "object" +}, +"logConfig": { +"$ref": "WasmPluginLogConfig", +"description": "Optional. Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging. Note that the settings relate to the logs generated by using logging statements in your Wasm code." +}, +"mainVersionId": { +"description": "Optional. The ID of the `WasmPluginVersion` resource that is the currently serving one. The version referred to must be a child of this `WasmPlugin` resource.", +"type": "string" +}, +"name": { +"description": "Identifier. Name of the `WasmPlugin` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}`.", +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when the resource was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"usedBy": { +"description": "Output only. List of all [Service Extensions](https://cloud.google.com/service-extensions/docs/overview) that use this `WasmPlugin`.", +"items": { +"$ref": "WasmPluginUsedBy" +}, +"readOnly": true, +"type": "array" +}, +"versions": { +"additionalProperties": { +"$ref": "WasmPluginVersionDetails" +}, +"description": "Optional. All versions of this `WasmPlugin` in the key-value format. The key is the resource ID, the value is the `VersionDetails`. Allows to create or update `WasmPlugin` and its WasmPluginVersions in a single request. When the `main_version_id` field is not empty it must point to one of the VersionDetails in the map. If provided in the update request, the new versions replace the previous set. Any version omitted from the `versions` will be removed. Since the `WasmPluginVersion` resource is immutable, if the WasmPluginVersion with the same name already exists and differs the Update request will fail. Note: In the GET request, this field is populated only if the GetWasmPluginRequest.view is set to WASM_PLUGIN_VIEW_FULL.", +"type": "object" +} +}, +"type": "object" +}, +"WasmPluginLogConfig": { +"description": "Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging.", +"id": "WasmPluginLogConfig", +"properties": { +"enable": { +"description": "Optional. Specifies whether to enable logging for activity by this `WasmPlugin`. Defaults to `false`.", +"type": "boolean" +}, +"minLogLevel": { +"description": "Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the `WasmPlugin` resource. If the field is not provided when logging is enabled, it is set to `INFO` by default.", +"enum": [ +"LOG_LEVEL_UNSPECIFIED", +"TRACE", +"DEBUG", +"INFO", +"WARN", +"ERROR", +"CRITICAL" +], +"enumDescriptions": [ +"Unspecified value.", +"Report logs with TRACE level and above.", +"Report logs with DEBUG level and above.", +"Report logs with INFO level and above.", +"Report logs with WARN level and above.", +"Report logs with ERROR level and above.", +"Report logs with CRITICAL level only." +], +"type": "string" +}, +"sampleRate": { +"description": "Non-empty default. Configures the sampling rate of activity logs, where `1.0` means all logged activity is reported and `0.0` means no activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must be between `0` and `1` (inclusive). This field can only be specified if logging is enabled for this `WasmPlugin`.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"WasmPluginUsedBy": { +"description": "Defines a resource that uses the `WasmPlugin`.", +"id": "WasmPluginUsedBy", +"properties": { +"name": { +"description": "Output only. Full name of the resource https://google.aip.dev/122#full-resource-names, e.g. `//networkservices.googleapis.com/projects/{project}/locations/{location}/lbRouteExtensions/{extension}`", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"WasmPluginVersion": { +"description": "A single immutable version of a `WasmPlugin`. Defines the Wasm module used and optionally its runtime config.", +"id": "WasmPluginVersion", +"properties": { +"createTime": { +"description": "Output only. The timestamp when the resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. A human-readable description of the resource.", +"type": "string" +}, +"imageDigest": { +"description": "Output only. The resolved digest for the image specified in `image`. The digest is resolved during the creation of `WasmPluginVersion` resource. This field holds the digest value regardless of whether a tag or digest was originally specified in the `image` field.", +"readOnly": true, +"type": "string" +}, +"imageUri": { +"description": "Optional. URI of the container image containing the Wasm plugin, stored in the Artifact Registry. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `image_digest` field. When downloading an image, the digest value is used instead of an image tag.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Set of labels associated with the `WasmPluginVersion` resource.", +"type": "object" +}, +"name": { +"description": "Identifier. Name of the `WasmPluginVersion` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}/ versions/{wasm_plugin_version}`.", +"type": "string" +}, +"pluginConfigData": { +"description": "Configuration for the Wasm plugin. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When a new `WasmPluginVersion` resource is created, the digest of the contents is saved in the `plugin_config_digest` field.", +"format": "byte", +"type": "string" +}, +"pluginConfigDigest": { +"description": "Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of the `plugin_config_data` or the container image defined by the `plugin_config_uri` field.", +"readOnly": true, +"type": "string" +}, +"pluginConfigUri": { +"description": "URI of the Wasm plugin configuration stored in the Artifact Registry. The configuration is provided to the plugin at runtime through the `ON_CONFIGURE` callback. The container image must contain only a single file with the name `plugin.config`. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `plugin_config_digest` field.", +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when the resource was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"WasmPluginVersionDetails": { +"description": "Details of a `WasmPluginVersion` resource to be inlined in the `WasmPlugin` resource.", +"id": "WasmPluginVersionDetails", +"properties": { +"createTime": { +"description": "Output only. The timestamp when the resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. A human-readable description of the resource.", +"type": "string" +}, +"imageDigest": { +"description": "Output only. The resolved digest for the image specified in `image`. The digest is resolved during the creation of a `WasmPluginVersion` resource. This field holds the digest value regardless of whether a tag or digest was originally specified in the `image` field.", +"readOnly": true, +"type": "string" +}, +"imageUri": { +"description": "Optional. URI of the container image containing the Wasm module, stored in the Artifact Registry. The container image must contain only a single file with the name `plugin.wasm`. When a new `WasmPluginVersion` resource is created, the URI gets resolved to an image digest and saved in the `image_digest` field.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Set of labels associated with the `WasmPluginVersion` resource.", +"type": "object" +}, +"pluginConfigData": { +"description": "Configuration for the Wasm plugin. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When a new `WasmPluginVersion` version is created, the digest of the contents is saved in the `plugin_config_digest` field.", +"format": "byte", +"type": "string" +}, +"pluginConfigDigest": { +"description": "Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of the `plugin_config_data` or the container image defined by the `plugin_config_uri` field.", +"readOnly": true, +"type": "string" +}, +"pluginConfigUri": { +"description": "URI of the WasmPlugin configuration stored in the Artifact Registry. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. The container image must contain only a single file with the name `plugin.config`. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `plugin_config_digest` field.", +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when the resource was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json index 0630998fbe..263d015369 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json @@ -1885,7 +1885,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`.", +"description": "Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/serviceLbPolicies/[^/]+$", "required": true, @@ -2224,13 +2224,310 @@ ] } } +}, +"wasmPlugins": { +"methods": { +"create": { +"description": "Creates a new `WasmPlugin` resource in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/wasmPlugins", +"httpMethod": "POST", +"id": "networkservices.projects.locations.wasmPlugins.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource of the `WasmPlugin` resource. Must be in the format `projects/{project}/locations/global`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"wasmPluginId": { +"description": "Required. User-provided ID of the `WasmPlugin` resource to be created.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+parent}/wasmPlugins", +"request": { +"$ref": "WasmPlugin" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes the specified `WasmPlugin` resource.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/wasmPlugins/{wasmPluginsId}", +"httpMethod": "DELETE", +"id": "networkservices.projects.locations.wasmPlugins.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. A name of the `WasmPlugin` resource to delete. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/wasmPlugins/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of the specified `WasmPlugin` resource.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/wasmPlugins/{wasmPluginsId}", +"httpMethod": "GET", +"id": "networkservices.projects.locations.wasmPlugins.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. A name of the `WasmPlugin` resource to get. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/wasmPlugins/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Determine how much data should be returned by the API. See [AIP-157](https://google.aip.dev/157).", +"enum": [ +"WASM_PLUGIN_VIEW_UNSPECIFIED", +"WASM_PLUGIN_VIEW_BASIC", +"WASM_PLUGIN_VIEW_FULL" +], +"enumDescriptions": [ +"The default / unset value. The API will default to the BASIC view.", +"Include just WasmPlugin record.", +"Include WasmPlugin record and all its WasmPluginVersions." +], +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "WasmPlugin" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists `WasmPlugin` resources in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/wasmPlugins", +"httpMethod": "GET", +"id": "networkservices.projects.locations.wasmPlugins.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of `WasmPlugin` resources to return per call. If not specified, at most 50 `WasmPlugin`s are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The value returned by the last `ListWasmPluginsResponse` call. Indicates that this is a continuation of a prior `ListWasmPlugins` call, and that the next page of data is to be returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project and location from which the `WasmPlugin` resources are listed, specified in the following format: `projects/{project}/locations/global`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/wasmPlugins", +"response": { +"$ref": "ListWasmPluginsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of the specified `WasmPlugin` resource.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/wasmPlugins/{wasmPluginsId}", +"httpMethod": "PATCH", +"id": "networkservices.projects.locations.wasmPlugins.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Name of the `WasmPlugin` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/wasmPlugins/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Used to specify the fields to be overwritten in the `WasmPlugin` resource by the update. The fields specified in the `update_mask` field are relative to the resource, not the full request. An omitted `update_mask` field is treated as an implied `update_mask` field equivalent to all fields that are populated (that have a non-empty value). The `update_mask` field supports a special value `*`, which means that each field in the given `WasmPlugin` resource (including the empty ones) replaces the current value.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "WasmPlugin" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"versions": { +"methods": { +"create": { +"description": "Creates a new `WasmPluginVersion` resource in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/wasmPlugins/{wasmPluginsId}/versions", +"httpMethod": "POST", +"id": "networkservices.projects.locations.wasmPlugins.versions.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource of the `WasmPluginVersion` resource. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/wasmPlugins/[^/]+$", +"required": true, +"type": "string" +}, +"wasmPluginVersionId": { +"description": "Required. User-provided ID of the `WasmPluginVersion` resource to be created.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+parent}/versions", +"request": { +"$ref": "WasmPluginVersion" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes the specified `WasmPluginVersion` resource.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/wasmPlugins/{wasmPluginsId}/versions/{versionsId}", +"httpMethod": "DELETE", +"id": "networkservices.projects.locations.wasmPlugins.versions.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. A name of the `WasmPluginVersion` resource to delete. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}/versions/{wasm_plugin_version}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/wasmPlugins/[^/]+/versions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of the specified `WasmPluginVersion` resource.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/wasmPlugins/{wasmPluginsId}/versions/{versionsId}", +"httpMethod": "GET", +"id": "networkservices.projects.locations.wasmPlugins.versions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. A name of the `WasmPluginVersion` resource to get. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}/versions/{wasm_plugin_version}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/wasmPlugins/[^/]+/versions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "WasmPluginVersion" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists `WasmPluginVersion` resources in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/wasmPlugins/{wasmPluginsId}/versions", +"httpMethod": "GET", +"id": "networkservices.projects.locations.wasmPlugins.versions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of `WasmPluginVersion` resources to return per call. If not specified, at most 50 `WasmPluginVersion`s are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The value returned by the last `ListWasmPluginVersionsResponse` call. Indicates that this is a continuation of a prior `ListWasmPluginVersions` call, and that the next page of data is to be returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The `WasmPlugin` resource whose `WasmPluginVersion`s are listed, specified in the following format: `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/wasmPlugins/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/versions", +"response": { +"$ref": "ListWasmPluginVersionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} } } } } } }, -"revision": "20240919", +"revision": "20241010", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuthzExtension": { @@ -2443,7 +2740,7 @@ "id": "ExtensionChainExtension", "properties": { "authority": { -"description": "Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions.", +"description": "Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions and must not be set.", "type": "string" }, "failOpen": { @@ -2457,12 +2754,20 @@ }, "type": "array" }, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set.", +"type": "object" +}, "name": { "description": "Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.", "type": "string" }, "service": { -"description": "Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`.", +"description": "Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, this must be a reference to a [wasm plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`.", "type": "string" }, "supportedEvents": { @@ -2491,7 +2796,7 @@ "type": "array" }, "timeout": { -"description": "Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions.", +"description": "Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for callout extensions. This field is not supported for plugin extensions and must not be set.", "format": "google-duration", "type": "string" } @@ -3555,7 +3860,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name.", +"description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set.", "type": "object" }, "name": { @@ -3625,7 +3930,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name.", +"description": "Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions and must not be set.", "type": "object" }, "name": { @@ -3921,6 +4226,42 @@ }, "type": "object" }, +"ListWasmPluginVersionsResponse": { +"description": "Response returned by the `ListWasmPluginVersions` method.", +"id": "ListWasmPluginVersionsResponse", +"properties": { +"nextPageToken": { +"description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", +"type": "string" +}, +"wasmPluginVersions": { +"description": "List of `WasmPluginVersion` resources.", +"items": { +"$ref": "WasmPluginVersion" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListWasmPluginsResponse": { +"description": "Response returned by the `ListWasmPlugins` method.", +"id": "ListWasmPluginsResponse", +"properties": { +"nextPageToken": { +"description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", +"type": "string" +}, +"wasmPlugins": { +"description": "List of `WasmPlugin` resources.", +"items": { +"$ref": "WasmPlugin" +}, +"type": "array" +} +}, +"type": "object" +}, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", @@ -4271,7 +4612,7 @@ "type": "string" }, "name": { -"description": "Required. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`.", +"description": "Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`.", "type": "string" }, "updateTime": { @@ -4612,6 +4953,223 @@ } }, "type": "object" +}, +"WasmPlugin": { +"description": "`WasmPlugin` is a resource representing a service executing a customer-provided Wasm module.", +"id": "WasmPlugin", +"properties": { +"createTime": { +"description": "Output only. The timestamp when the resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. A human-readable description of the resource.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Set of labels associated with the `WasmPlugin` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).", +"type": "object" +}, +"logConfig": { +"$ref": "WasmPluginLogConfig", +"description": "Optional. Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging. Note that the settings relate to the logs generated by using logging statements in your Wasm code." +}, +"mainVersionId": { +"description": "Optional. The ID of the `WasmPluginVersion` resource that is the currently serving one. The version referred to must be a child of this `WasmPlugin` resource.", +"type": "string" +}, +"name": { +"description": "Identifier. Name of the `WasmPlugin` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}`.", +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when the resource was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"usedBy": { +"description": "Output only. List of all [Service Extensions](https://cloud.google.com/service-extensions/docs/overview) that use this `WasmPlugin`.", +"items": { +"$ref": "WasmPluginUsedBy" +}, +"readOnly": true, +"type": "array" +}, +"versions": { +"additionalProperties": { +"$ref": "WasmPluginVersionDetails" +}, +"description": "Optional. All versions of this `WasmPlugin` in the key-value format. The key is the resource ID, the value is the `VersionDetails`. Allows to create or update `WasmPlugin` and its WasmPluginVersions in a single request. When the `main_version_id` field is not empty it must point to one of the VersionDetails in the map. If provided in the update request, the new versions replace the previous set. Any version omitted from the `versions` will be removed. Since the `WasmPluginVersion` resource is immutable, if the WasmPluginVersion with the same name already exists and differs the Update request will fail. Note: In the GET request, this field is populated only if the GetWasmPluginRequest.view is set to WASM_PLUGIN_VIEW_FULL.", +"type": "object" +} +}, +"type": "object" +}, +"WasmPluginLogConfig": { +"description": "Specifies the logging options for the activity performed by this `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud Logging.", +"id": "WasmPluginLogConfig", +"properties": { +"enable": { +"description": "Optional. Specifies whether to enable logging for activity by this `WasmPlugin`. Defaults to `false`.", +"type": "boolean" +}, +"minLogLevel": { +"description": "Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the `WasmPlugin` resource. If the field is not provided when logging is enabled, it is set to `INFO` by default.", +"enum": [ +"LOG_LEVEL_UNSPECIFIED", +"TRACE", +"DEBUG", +"INFO", +"WARN", +"ERROR", +"CRITICAL" +], +"enumDescriptions": [ +"Unspecified value.", +"Report logs with TRACE level and above.", +"Report logs with DEBUG level and above.", +"Report logs with INFO level and above.", +"Report logs with WARN level and above.", +"Report logs with ERROR level and above.", +"Report logs with CRITICAL level only." +], +"type": "string" +}, +"sampleRate": { +"description": "Non-empty default. Configures the sampling rate of activity logs, where `1.0` means all logged activity is reported and `0.0` means no activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must be between `0` and `1` (inclusive). This field can only be specified if logging is enabled for this `WasmPlugin`.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"WasmPluginUsedBy": { +"description": "Defines a resource that uses the `WasmPlugin`.", +"id": "WasmPluginUsedBy", +"properties": { +"name": { +"description": "Output only. Full name of the resource https://google.aip.dev/122#full-resource-names, e.g. `//networkservices.googleapis.com/projects/{project}/locations/{location}/lbRouteExtensions/{extension}`", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"WasmPluginVersion": { +"description": "A single immutable version of a `WasmPlugin`. Defines the Wasm module used and optionally its runtime config.", +"id": "WasmPluginVersion", +"properties": { +"createTime": { +"description": "Output only. The timestamp when the resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. A human-readable description of the resource.", +"type": "string" +}, +"imageDigest": { +"description": "Output only. The resolved digest for the image specified in `image`. The digest is resolved during the creation of `WasmPluginVersion` resource. This field holds the digest value regardless of whether a tag or digest was originally specified in the `image` field.", +"readOnly": true, +"type": "string" +}, +"imageUri": { +"description": "Optional. URI of the container image containing the Wasm plugin, stored in the Artifact Registry. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `image_digest` field. When downloading an image, the digest value is used instead of an image tag.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Set of labels associated with the `WasmPluginVersion` resource.", +"type": "object" +}, +"name": { +"description": "Identifier. Name of the `WasmPluginVersion` resource in the following format: `projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}/ versions/{wasm_plugin_version}`.", +"type": "string" +}, +"pluginConfigData": { +"description": "Configuration for the Wasm plugin. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When a new `WasmPluginVersion` resource is created, the digest of the contents is saved in the `plugin_config_digest` field.", +"format": "byte", +"type": "string" +}, +"pluginConfigDigest": { +"description": "Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of the `plugin_config_data` or the container image defined by the `plugin_config_uri` field.", +"readOnly": true, +"type": "string" +}, +"pluginConfigUri": { +"description": "URI of the Wasm plugin configuration stored in the Artifact Registry. The configuration is provided to the plugin at runtime through the `ON_CONFIGURE` callback. The container image must contain only a single file with the name `plugin.config`. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `plugin_config_digest` field.", +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when the resource was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"WasmPluginVersionDetails": { +"description": "Details of a `WasmPluginVersion` resource to be inlined in the `WasmPlugin` resource.", +"id": "WasmPluginVersionDetails", +"properties": { +"createTime": { +"description": "Output only. The timestamp when the resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. A human-readable description of the resource.", +"type": "string" +}, +"imageDigest": { +"description": "Output only. The resolved digest for the image specified in `image`. The digest is resolved during the creation of a `WasmPluginVersion` resource. This field holds the digest value regardless of whether a tag or digest was originally specified in the `image` field.", +"readOnly": true, +"type": "string" +}, +"imageUri": { +"description": "Optional. URI of the container image containing the Wasm module, stored in the Artifact Registry. The container image must contain only a single file with the name `plugin.wasm`. When a new `WasmPluginVersion` resource is created, the URI gets resolved to an image digest and saved in the `image_digest` field.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Set of labels associated with the `WasmPluginVersion` resource.", +"type": "object" +}, +"pluginConfigData": { +"description": "Configuration for the Wasm plugin. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When a new `WasmPluginVersion` version is created, the digest of the contents is saved in the `plugin_config_digest` field.", +"format": "byte", +"type": "string" +}, +"pluginConfigDigest": { +"description": "Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the contents of the `plugin_config_data` or the container image defined by the `plugin_config_uri` field.", +"readOnly": true, +"type": "string" +}, +"pluginConfigUri": { +"description": "URI of the WasmPlugin configuration stored in the Artifact Registry. The configuration is provided to the Wasm plugin at runtime through the `ON_CONFIGURE` callback. The container image must contain only a single file with the name `plugin.config`. When a new `WasmPluginVersion` resource is created, the digest of the container image is saved in the `plugin_config_digest` field.", +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when the resource was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/notebooks.v1.json b/googleapiclient/discovery_cache/documents/notebooks.v1.json index 953227be8a..dc702d73f2 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v1.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v1.json @@ -2008,7 +2008,7 @@ } } }, -"revision": "20240918", +"revision": "20241016", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2132,7 +2132,7 @@ "description": "Required. Defines flags that are used to run the diagnostic tool" }, "timeoutMinutes": { -"description": "Optional. Maxmium amount of time in minutes before the operation times out.", +"description": "Optional. Maximum amount of time in minutes before the operation times out.", "format": "int32", "type": "integer" } @@ -2148,7 +2148,7 @@ "description": "Required. Defines flags that are used to run the diagnostic tool" }, "timeoutMinutes": { -"description": "Optional. Maxmium amount of time in minutes before the operation times out.", +"description": "Optional. Maximum amount of time in minutes before the operation times out.", "format": "int32", "type": "integer" } diff --git a/googleapiclient/discovery_cache/documents/notebooks.v2.json b/googleapiclient/discovery_cache/documents/notebooks.v2.json index 4e79bcf441..c3d7a6f4e1 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v2.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v2.json @@ -904,7 +904,7 @@ } } }, -"revision": "20240918", +"revision": "20241016", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1168,7 +1168,7 @@ "description": "Required. Defines flags that are used to run the diagnostic tool" }, "timeoutMinutes": { -"description": "Optional. Maxmium amount of time in minutes before the operation times out.", +"description": "Optional. Maximum amount of time in minutes before the operation times out.", "format": "int32", "type": "integer" } diff --git a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json index 238f874901..8c944cac6a 100644 --- a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json +++ b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json @@ -1119,7 +1119,7 @@ } } }, -"revision": "20241002", +"revision": "20241009", "rootUrl": "https://oracledatabase.googleapis.com/", "schemas": { "AllConnectionStrings": { @@ -2237,8 +2237,9 @@ "type": "integer" }, "cpuCount": { -"description": "Optional. The number of enabled CPU cores.", +"description": "Output only. The number of enabled CPU cores.", "format": "int32", +"readOnly": true, "type": "integer" }, "customerContacts": { @@ -2255,8 +2256,9 @@ "type": "number" }, "dbNodeStorageSizeGb": { -"description": "Optional. The local node storage allocated in GBs.", +"description": "Output only. The local node storage allocated in GBs.", "format": "int32", +"readOnly": true, "type": "integer" }, "dbServerVersion": { @@ -2293,8 +2295,9 @@ "type": "integer" }, "memorySizeGb": { -"description": "Optional. The memory allocated in GBs.", +"description": "Output only. The memory allocated in GBs.", "format": "int32", +"readOnly": true, "type": "integer" }, "monthlyDbServerVersion": { diff --git a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json index e13911926f..fcdf6379b1 100644 --- a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json +++ b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json @@ -930,7 +930,7 @@ } } }, -"revision": "20240621", +"revision": "20241021", "rootUrl": "https://orgpolicy.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -996,7 +996,136 @@ "GoogleCloudOrgpolicyV2ConstraintBooleanConstraint": { "description": "A constraint that is either enforced or not. For example, a constraint `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM instance, serial port connections will not be opened to that instance.", "id": "GoogleCloudOrgpolicyV2ConstraintBooleanConstraint", -"properties": {}, +"properties": { +"customConstraintDefinition": { +"$ref": "GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition", +"description": "Custom constraint definition. This is set only for Managed Constraints" +} +}, +"type": "object" +}, +"GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition": { +"description": "Currently used for Managed Constraints. This represents a subset of fields missing from Constraint proto that are required to describe CustomConstraint", +"id": "GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition", +"properties": { +"actionType": { +"description": "Allow or deny type.", +"enum": [ +"ACTION_TYPE_UNSPECIFIED", +"ALLOW", +"DENY" +], +"enumDescriptions": [ +"Unspecified. Results in an error.", +"Allowed action type.", +"Deny action type." +], +"type": "string" +}, +"condition": { +"description": "Org policy condition/expression. For example: `resource.instanceName.matches(\"[production|test]_.*_(\\d)+\")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters.", +"type": "string" +}, +"methodTypes": { +"description": "All the operations being applied for this constraint.", +"items": { +"enum": [ +"METHOD_TYPE_UNSPECIFIED", +"CREATE", +"UPDATE", +"DELETE", +"REMOVE_GRANT", +"GOVERN_TAGS" +], +"enumDescriptions": [ +"Unspecified. Results in an error.", +"Constraint applied when creating the resource.", +"Constraint applied when updating the resource.", +"Constraint applied when deleting the resource. Not supported yet.", +"Constraint applied when removing an IAM grant.", +"Constraint applied when enforcing forced tagging." +], +"type": "string" +}, +"type": "array" +}, +"parameters": { +"additionalProperties": { +"$ref": "GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameter" +}, +"description": "Stores Structure of parameters used by Constraint condition. Key of map represents name of the parameter.", +"type": "object" +}, +"resourceTypes": { +"description": "The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameter": { +"description": "Defines a parameter structure.", +"id": "GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameter", +"properties": { +"defaultValue": { +"description": "Sets the value of the parameter in an assignment if no value is given.", +"type": "any" +}, +"item": { +"description": "Determines the parameter\u2019s value structure. For example, LIST can be specified by defining type : LIST, and item type as : STRING.", +"enum": [ +"TYPE_UNSPECIFIED", +"LIST", +"STRING", +"BOOLEAN" +], +"enumDescriptions": [ +"Unspecified. Results in an error.", +"List parameter type.", +"String parameter type.", +"Boolean parameter type." +], +"type": "string" +}, +"metadata": { +"$ref": "GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetadata", +"description": "Defines subproperties primarily used by the UI to display user-friendly information." +}, +"type": { +"description": "Type of the parameter.", +"enum": [ +"TYPE_UNSPECIFIED", +"LIST", +"STRING", +"BOOLEAN" +], +"enumDescriptions": [ +"Unspecified. Results in an error.", +"List parameter type.", +"String parameter type.", +"Boolean parameter type." +], +"type": "string" +}, +"validValuesExpr": { +"description": "Provides a CEL expression to specify the acceptable parameter values during assignment. For example, parameterName in (\"parameterValue1\", \"parameterValue2\")", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetadata": { +"description": "Defines Medata structure.", +"id": "GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetadata", +"properties": { +"description": { +"description": "Detailed description of what this `parameter` is and use of it. Mutable.", +"type": "string" +} +}, "type": "object" }, "GoogleCloudOrgpolicyV2ConstraintListConstraint": { diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1.json b/googleapiclient/discovery_cache/documents/osconfig.v1.json index bded9c61a7..6a7142b545 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1.json @@ -1083,7 +1083,7 @@ } } }, -"revision": "20241002", +"revision": "20241021", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptSettings": { @@ -1495,6 +1495,50 @@ }, "type": "object" }, +"GoogleCloudOsconfigV2beta__OperationMetadata": { +"description": "Represents the metadata of the long-running operation.", +"id": "GoogleCloudOsconfigV2beta__OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Inventory": { "description": "This API resource represents the available inventory data for a Compute Engine virtual machine (VM) instance at a given point in time. You can use this API resource to determine the inventory data of your VM. For more information, see [Information provided by OS inventory management](https://cloud.google.com/compute/docs/instances/os-inventory-management#data-collected).", "id": "Inventory", diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json b/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json index 1ade03dd8d..93e533a677 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json @@ -707,7 +707,7 @@ } } }, -"revision": "20240901", +"revision": "20241021", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CVSSv3": { @@ -962,6 +962,50 @@ }, "type": "object" }, +"GoogleCloudOsconfigV2beta__OperationMetadata": { +"description": "Represents the metadata of the long-running operation.", +"id": "GoogleCloudOsconfigV2beta__OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "InstanceOSPoliciesCompliance": { "deprecated": true, "description": "This API resource represents the OS policies compliance data for a Compute Engine virtual machine (VM) instance at a given point in time. A Compute Engine VM can have multiple OS policy assignments, and each assignment can have multiple OS policies. As a result, multiple OS policies could be applied to a single VM. You can use this API resource to determine both the compliance state of your VM as well as the compliance state of an individual OS policy. For more information, see [View compliance](https://cloud.google.com/compute/docs/os-configuration-management/view-compliance).", diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1beta.json b/googleapiclient/discovery_cache/documents/osconfig.v1beta.json index ada8ea2aa1..f9f220b056 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1beta.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1beta.json @@ -689,7 +689,7 @@ } } }, -"revision": "20241002", +"revision": "20241021", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptRepository": { @@ -1130,6 +1130,50 @@ }, "type": "object" }, +"GoogleCloudOsconfigV2beta__OperationMetadata": { +"description": "Represents the metadata of the long-running operation.", +"id": "GoogleCloudOsconfigV2beta__OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GuestPolicy": { "description": "An OS Config resource representing a guest configuration policy. These policies represent the desired state for VM instance guest environments including packages to install or remove, package repository configurations, and software to install.", "id": "GuestPolicy", diff --git a/googleapiclient/discovery_cache/documents/places.v1.json b/googleapiclient/discovery_cache/documents/places.v1.json index bb77593ff8..c2792d685d 100644 --- a/googleapiclient/discovery_cache/documents/places.v1.json +++ b/googleapiclient/discovery_cache/documents/places.v1.json @@ -280,7 +280,7 @@ } } }, -"revision": "20240920", +"revision": "20241022", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -298,6 +298,120 @@ }, "type": "object" }, +"GoogleMapsPlacesV1AddressDescriptor": { +"description": "A relational description of a location. Includes a ranked set of nearby landmarks and precise containing areas and their relationship to the target location.", +"id": "GoogleMapsPlacesV1AddressDescriptor", +"properties": { +"areas": { +"description": "A ranked list of containing or adjacent areas. The most recognizable and precise areas are ranked first.", +"items": { +"$ref": "GoogleMapsPlacesV1AddressDescriptorArea" +}, +"type": "array" +}, +"landmarks": { +"description": "A ranked list of nearby landmarks. The most recognizable and nearby landmarks are ranked first.", +"items": { +"$ref": "GoogleMapsPlacesV1AddressDescriptorLandmark" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleMapsPlacesV1AddressDescriptorArea": { +"description": "Area information and the area's relationship with the target location. Areas includes precise sublocality, neighborhoods, and large compounds that are useful for describing a location.", +"id": "GoogleMapsPlacesV1AddressDescriptorArea", +"properties": { +"containment": { +"description": "Defines the spatial relationship between the target location and the area.", +"enum": [ +"CONTAINMENT_UNSPECIFIED", +"WITHIN", +"OUTSKIRTS", +"NEAR" +], +"enumDescriptions": [ +"The containment is unspecified.", +"The target location is within the area region, close to the center.", +"The target location is within the area region, close to the edge.", +"The target location is outside the area region, but close by." +], +"type": "string" +}, +"displayName": { +"$ref": "GoogleTypeLocalizedText", +"description": "The area's display name." +}, +"name": { +"description": "The area's resource name.", +"type": "string" +}, +"placeId": { +"description": "The area's place id.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleMapsPlacesV1AddressDescriptorLandmark": { +"description": "Basic landmark information and the landmark's relationship with the target location. Landmarks are prominent places that can be used to describe a location.", +"id": "GoogleMapsPlacesV1AddressDescriptorLandmark", +"properties": { +"displayName": { +"$ref": "GoogleTypeLocalizedText", +"description": "The landmark's display name." +}, +"name": { +"description": "The landmark's resource name.", +"type": "string" +}, +"placeId": { +"description": "The landmark's place id.", +"type": "string" +}, +"spatialRelationship": { +"description": "Defines the spatial relationship between the target location and the landmark.", +"enum": [ +"NEAR", +"WITHIN", +"BESIDE", +"ACROSS_THE_ROAD", +"DOWN_THE_ROAD", +"AROUND_THE_CORNER", +"BEHIND" +], +"enumDescriptions": [ +"This is the default relationship when nothing more specific below applies.", +"The landmark has a spatial geometry and the target is within its bounds.", +"The target is directly adjacent to the landmark.", +"The target is directly opposite the landmark on the other side of the road.", +"On the same route as the landmark but not besides or across.", +"Not on the same route as the landmark but a single turn away.", +"Close to the landmark's structure but further away from its street entrances." +], +"type": "string" +}, +"straightLineDistanceMeters": { +"description": "The straight line distance, in meters, between the center point of the target and the center point of the landmark. In some situations, this value can be longer than `travel_distance_meters`.", +"format": "float", +"type": "number" +}, +"travelDistanceMeters": { +"description": "The travel distance, in meters, along the road network from the target to the landmark, if known. This value does not take into account the mode of transportation, such as walking, driving, or biking.", +"format": "float", +"type": "number" +}, +"types": { +"description": "A set of type tags for this landmark. For a complete list of possible values, see https://developers.google.com/maps/documentation/places/web-service/place-types.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleMapsPlacesV1AuthorAttribution": { "description": "Information about the author of the UGC data. Used in Photo, and Review.", "id": "GoogleMapsPlacesV1AuthorAttribution", @@ -890,6 +1004,10 @@ }, "type": "array" }, +"addressDescriptor": { +"$ref": "GoogleMapsPlacesV1AddressDescriptor", +"description": "The address descriptor of the place. Address descriptors include additional information that help describe a location using landmarks and areas. See address descriptor regional coverage in https://developers.google.com/maps/documentation/geocoding/address-descriptors/coverage." +}, "adrFormatAddress": { "description": "The place's address in adr microformat: http://microformats.org/wiki/adr.", "type": "string" @@ -1180,7 +1298,7 @@ }, "viewport": { "$ref": "GoogleGeoTypeViewport", -"description": "A viewport suitable for displaying the place on an average-sized map." +"description": "A viewport suitable for displaying the place on an average-sized map. This viewport should not be used as the physical boundary or the service area of the business." }, "websiteUri": { "description": "The authoritative website for this place, e.g. a business' homepage. Note that for places that are part of a chain (e.g. an IKEA store), this will usually be the website for the individual store, not the overall chain.", diff --git a/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json b/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json index a0847b8496..adc8c73244 100644 --- a/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json +++ b/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json @@ -207,7 +207,7 @@ } } }, -"revision": "20240708", +"revision": "20241015", "rootUrl": "https://readerrevenuesubscriptionlinking.googleapis.com/", "schemas": { "DeleteReaderResponse": { @@ -225,7 +225,7 @@ "type": "string" }, "expireTime": { -"description": "Required. Expiration time of the entitlement. Entitlements that have expired over 30 days will be purged. Required. LINT.IfChange(expire_time) The max expire_time is 398 days from now(). LINT.ThenChange(//depot/google3/java/com/google/subscribewithgoogle/accountlinking/subscriptionlink/service/config/protoconf.pi:max_expiry_age)", +"description": "Required. Expiration time of the entitlement. Entitlements that have expired over 30 days will be purged. The max expire_time is 398 days from now().", "format": "google-datetime", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index 3fbca64f83..216272da4e 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -786,7 +786,7 @@ } } }, -"revision": "20240906", +"revision": "20241013", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -1854,6 +1854,23 @@ true "description": "Risk analysis result for an event.", "id": "GoogleCloudRecaptchaenterpriseV1RiskAnalysis", "properties": { +"challenge": { +"description": "Output only. Challenge information for SCORE_AND_CHALLENGE keys", +"enum": [ +"CHALLENGE_UNSPECIFIED", +"NOCAPTCHA", +"PASSED", +"FAILED" +], +"enumDescriptions": [ +"Default unspecified type.", +"No challenge was presented for solving.", +"A solution was submitted that was correct.", +"A solution was submitted that was incorrect or otherwise deemed suspicious." +], +"readOnly": true, +"type": "string" +}, "extendedVerdictReasons": { "description": "Output only. Extended verdict reasons to be used for experimentation only. The set of possible reasons is subject to change.", "items": { diff --git a/googleapiclient/discovery_cache/documents/recommender.v1.json b/googleapiclient/discovery_cache/documents/recommender.v1.json index 65cb8b923a..e0debcb154 100644 --- a/googleapiclient/discovery_cache/documents/recommender.v1.json +++ b/googleapiclient/discovery_cache/documents/recommender.v1.json @@ -1686,7 +1686,7 @@ } } }, -"revision": "20240630", +"revision": "20241013", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudRecommenderV1CostProjection": { @@ -1739,6 +1739,13 @@ "$ref": "GoogleCloudRecommenderV1CostProjection", "description": "Use with CategoryType.COST" }, +"impactComponents": { +"description": "If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.", +"items": { +"$ref": "GoogleCloudRecommenderV1Impact" +}, +"type": "array" +}, "reliabilityProjection": { "$ref": "GoogleCloudRecommenderV1ReliabilityProjection", "description": "Use with CategoryType.RELIABILITY" @@ -1747,6 +1754,10 @@ "$ref": "GoogleCloudRecommenderV1SecurityProjection", "description": "Use with CategoryType.SECURITY" }, +"service": { +"description": "The service that this impact is associated with.", +"type": "string" +}, "sustainabilityProjection": { "$ref": "GoogleCloudRecommenderV1SustainabilityProjection", "description": "Use with CategoryType.SUSTAINABILITY" diff --git a/googleapiclient/discovery_cache/documents/recommender.v1beta1.json b/googleapiclient/discovery_cache/documents/recommender.v1beta1.json index c89b1395ff..8913e8e9ae 100644 --- a/googleapiclient/discovery_cache/documents/recommender.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/recommender.v1beta1.json @@ -1920,7 +1920,7 @@ } } }, -"revision": "20240630", +"revision": "20241013", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudLocationListLocationsResponse": { @@ -2039,6 +2039,13 @@ "$ref": "GoogleCloudRecommenderV1beta1CostProjection", "description": "Use with CategoryType.COST" }, +"impactComponents": { +"description": "If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.", +"items": { +"$ref": "GoogleCloudRecommenderV1beta1Impact" +}, +"type": "array" +}, "reliabilityProjection": { "$ref": "GoogleCloudRecommenderV1beta1ReliabilityProjection", "description": "Use with CategoryType.RELIABILITY" @@ -2047,6 +2054,10 @@ "$ref": "GoogleCloudRecommenderV1beta1SecurityProjection", "description": "Use with CategoryType.SECURITY" }, +"service": { +"description": "The service that this impact is associated with.", +"type": "string" +}, "sustainabilityProjection": { "$ref": "GoogleCloudRecommenderV1beta1SustainabilityProjection", "description": "Use with CategoryType.SUSTAINABILITY" diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index dce3d1b9fb..081ced27fe 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -849,7 +849,7 @@ } } }, -"revision": "20241003", +"revision": "20241017", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -875,42 +875,6 @@ }, "type": "object" }, -"AssetLocation": { -"description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", -"id": "AssetLocation", -"properties": { -"ccfeRmsPath": { -"description": "Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata.", -"type": "string" -}, -"expected": { -"$ref": "IsolationExpectations", -"description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." -}, -"extraParameters": { -"description": "Defines extra parameters required for specific asset types.", -"items": { -"$ref": "ExtraParameter" -}, -"type": "array" -}, -"locationData": { -"description": "Contains all kinds of physical location definitions for this asset.", -"items": { -"$ref": "LocationData" -}, -"type": "array" -}, -"parentAsset": { -"description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.", -"items": { -"$ref": "CloudAsset" -}, -"type": "array" -} -}, -"type": "object" -}, "AvailabilityConfiguration": { "description": "Configuration for availability of database instance", "id": "AvailabilityConfiguration", @@ -1004,19 +968,6 @@ }, "type": "object" }, -"BlobstoreLocation": { -"description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", -"id": "BlobstoreLocation", -"properties": { -"policyId": { -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "CertChain": { "id": "CertChain", "properties": { @@ -1044,30 +995,6 @@ }, "type": "object" }, -"CloudAsset": { -"id": "CloudAsset", -"properties": { -"assetName": { -"type": "string" -}, -"assetType": { -"type": "string" -} -}, -"type": "object" -}, -"CloudAssetComposition": { -"id": "CloudAssetComposition", -"properties": { -"childAsset": { -"items": { -"$ref": "CloudAsset" -}, -"type": "array" -} -}, -"type": "object" -}, "Cluster": { "description": "A cluster instance.", "id": "Cluster", @@ -1086,6 +1013,13 @@ ], "type": "string" }, +"clusterEndpoints": { +"description": "Optional. A list of cluster enpoints.", +"items": { +"$ref": "ClusterEndpoint" +}, +"type": "array" +}, "createTime": { "description": "Output only. The timestamp associated with the cluster creation request.", "format": "google-datetime", @@ -1150,7 +1084,7 @@ "type": "number" }, "pscConfigs": { -"description": "Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.", +"description": "Optional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.", "items": { "$ref": "PscConfig" }, @@ -1164,6 +1098,14 @@ "readOnly": true, "type": "array" }, +"pscServiceAttachments": { +"description": "Output only. Service attachment details to configure Psc connections", +"items": { +"$ref": "PscServiceAttachment" +}, +"readOnly": true, +"type": "array" +}, "redisConfigs": { "additionalProperties": { "type": "string" @@ -1237,6 +1179,20 @@ }, "type": "object" }, +"ClusterEndpoint": { +"description": "ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster.", +"id": "ClusterEndpoint", +"properties": { +"connections": { +"description": "A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster.", +"items": { +"$ref": "ConnectionDetail" +}, +"type": "array" +} +}, +"type": "object" +}, "ClusterMaintenancePolicy": { "description": "Maintenance policy per cluster.", "id": "ClusterMaintenancePolicy", @@ -1363,6 +1319,17 @@ }, "type": "object" }, +"ConnectionDetail": { +"description": "Detailed information of each PSC connection.", +"id": "ConnectionDetail", +"properties": { +"pscConnection": { +"$ref": "PscConnection", +"description": "Detailed information of a PSC connection that is created by the customer who owns the cluster." +} +}, +"type": "object" +}, "CrossClusterReplicationConfig": { "description": "Cross cluster replication config.", "id": "CrossClusterReplicationConfig", @@ -2360,18 +2327,6 @@ false }, "type": "object" }, -"DirectLocationAssignment": { -"id": "DirectLocationAssignment", -"properties": { -"location": { -"items": { -"$ref": "LocationAssignment" -}, -"type": "array" -} -}, -"type": "object" -}, "DiscoveryEndpoint": { "description": "Endpoints on each network, for Redis clients to connect to the cluster.", "id": "DiscoveryEndpoint", @@ -2445,17 +2400,6 @@ false }, "type": "object" }, -"ExtraParameter": { -"description": "Defines parameters that should only be used for specific asset types.", -"id": "ExtraParameter", -"properties": { -"regionalMigDistributionPolicy": { -"$ref": "RegionalMigDistributionPolicy", -"description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." -} -}, -"type": "object" -}, "FailoverInstanceRequest": { "description": "Request for Failover.", "id": "FailoverInstanceRequest", @@ -2877,131 +2821,6 @@ false }, "type": "object" }, -"IsolationExpectations": { -"id": "IsolationExpectations", -"properties": { -"requirementOverride": { -"$ref": "RequirementOverride", -"description": "Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic." -}, -"ziOrgPolicy": { -"enum": [ -"ZI_UNSPECIFIED", -"ZI_UNKNOWN", -"ZI_NOT_REQUIRED", -"ZI_PREFERRED", -"ZI_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"ziRegionPolicy": { -"enum": [ -"ZI_REGION_POLICY_UNSPECIFIED", -"ZI_REGION_POLICY_UNKNOWN", -"ZI_REGION_POLICY_NOT_SET", -"ZI_REGION_POLICY_FAIL_OPEN", -"ZI_REGION_POLICY_FAIL_CLOSED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"ziRegionState": { -"enum": [ -"ZI_REGION_UNSPECIFIED", -"ZI_REGION_UNKNOWN", -"ZI_REGION_NOT_ENABLED", -"ZI_REGION_ENABLED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -}, -"zoneIsolation": { -"deprecated": true, -"description": "Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location.", -"enum": [ -"ZI_UNSPECIFIED", -"ZI_UNKNOWN", -"ZI_NOT_REQUIRED", -"ZI_PREFERRED", -"ZI_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"zoneSeparation": { -"deprecated": true, -"description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.", -"enum": [ -"ZS_UNSPECIFIED", -"ZS_UNKNOWN", -"ZS_NOT_REQUIRED", -"ZS_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -}, -"zsOrgPolicy": { -"enum": [ -"ZS_UNSPECIFIED", -"ZS_UNKNOWN", -"ZS_NOT_REQUIRED", -"ZS_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -}, -"zsRegionState": { -"enum": [ -"ZS_REGION_UNSPECIFIED", -"ZS_REGION_UNKNOWN", -"ZS_REGION_NOT_ENABLED", -"ZS_REGION_ENABLED" -], -"enumDescriptions": [ -"", -"To be used if tracking of the asset ZS-bit is not available", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, "ListClustersResponse": { "description": "Response for ListClusters.", "id": "ListClustersResponse", @@ -3122,64 +2941,6 @@ false }, "type": "object" }, -"LocationAssignment": { -"id": "LocationAssignment", -"properties": { -"location": { -"type": "string" -}, -"locationType": { -"enum": [ -"UNSPECIFIED", -"CLUSTER", -"POP", -"CLOUD_ZONE", -"CLOUD_REGION", -"MULTI_REGION_GEO", -"MULTI_REGION_JURISDICTION", -"GLOBAL", -"OTHER" -], -"enumDescriptions": [ -"", -"1-10: Physical failure domains.", -"", -"11-20: Logical failure domains.", -"", -"", -"", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, -"LocationData": { -"id": "LocationData", -"properties": { -"blobstoreLocation": { -"$ref": "BlobstoreLocation" -}, -"childAssetLocation": { -"$ref": "CloudAssetComposition" -}, -"directLocation": { -"$ref": "DirectLocationAssignment" -}, -"gcpProjectProxy": { -"$ref": "TenantProjectProxy" -}, -"placerLocation": { -"$ref": "PlacerLocation" -}, -"spannerLocation": { -"$ref": "SpannerLocation" -} -}, -"type": "object" -}, "MachineConfiguration": { "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", "id": "MachineConfiguration", @@ -3545,17 +3306,6 @@ false }, "type": "object" }, -"PlacerLocation": { -"description": "Message describing that the location of the customer resource is tied to placer allocations", -"id": "PlacerLocation", -"properties": { -"placerConfig": { -"description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")", -"type": "string" -} -}, -"type": "object" -}, "Product": { "description": "Product specification for Condor resources.", "id": "Product", @@ -3689,6 +3439,23 @@ false "description": "Required. The IP allocated on the consumer network for the PSC forwarding rule.", "type": "string" }, +"connectionType": { +"description": "Output only. Type of the PSC connection.", +"enum": [ +"CONNECTION_TYPE_UNSPECIFIED", +"CONNECTION_TYPE_DISCOVERY", +"CONNECTION_TYPE_PRIMARY", +"CONNECTION_TYPE_READER" +], +"enumDescriptions": [ +"Cluster endpoint Type is not set", +"Cluster endpoint that will be used as for cluster topology discovery.", +"Cluster endpoint that will be used as primary endpoint to access primary.", +"Cluster endpoint that will be used as reader endpoint to access replicas." +], +"readOnly": true, +"type": "string" +}, "forwardingRule": { "description": "Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.", "type": "string" @@ -3705,6 +3472,21 @@ false "description": "Required. The PSC connection id of the forwarding rule connected to the service attachment.", "type": "string" }, +"pscConnectionStatus": { +"description": "Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details.", +"enum": [ +"PSC_CONNECTION_STATUS_UNSPECIFIED", +"PSC_CONNECTION_STATUS_ACTIVE", +"PSC_CONNECTION_STATUS_NOT_FOUND" +], +"enumDescriptions": [ +"PSC connection status is not specified.", +"The connection is active", +"Connection not found" +], +"readOnly": true, +"type": "string" +}, "serviceAttachment": { "description": "Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}.", "type": "string" @@ -3712,6 +3494,35 @@ false }, "type": "object" }, +"PscServiceAttachment": { +"description": "Configuration of a service attachment of the cluster, for creating PSC connections.", +"id": "PscServiceAttachment", +"properties": { +"connectionType": { +"description": "Output only. Type of a PSC connection targeting this service attachment.", +"enum": [ +"CONNECTION_TYPE_UNSPECIFIED", +"CONNECTION_TYPE_DISCOVERY", +"CONNECTION_TYPE_PRIMARY", +"CONNECTION_TYPE_READER" +], +"enumDescriptions": [ +"Cluster endpoint Type is not set", +"Cluster endpoint that will be used as for cluster topology discovery.", +"Cluster endpoint that will be used as primary endpoint to access primary.", +"Cluster endpoint that will be used as reader endpoint to access replicas." +], +"readOnly": true, +"type": "string" +}, +"serviceAttachment": { +"description": "Output only. Service attachment URI which your self-created PscConnection should use as target", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "RDBConfig": { "description": "Configuration of the RDB based persistence.", "id": "RDBConfig", @@ -3773,25 +3584,6 @@ false }, "type": "object" }, -"RegionalMigDistributionPolicy": { -"description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", -"id": "RegionalMigDistributionPolicy", -"properties": { -"targetShape": { -"description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum", -"format": "int32", -"type": "integer" -}, -"zones": { -"description": "Cloud zones used by regional MIG to create instances.", -"items": { -"$ref": "ZoneConfiguration" -}, -"type": "array" -} -}, -"type": "object" -}, "RemoteCluster": { "description": "Details of the remote cluster associated with this cluster in a cross cluster replication setup.", "id": "RemoteCluster", @@ -3808,44 +3600,6 @@ false }, "type": "object" }, -"RequirementOverride": { -"id": "RequirementOverride", -"properties": { -"ziOverride": { -"enum": [ -"ZI_UNSPECIFIED", -"ZI_UNKNOWN", -"ZI_NOT_REQUIRED", -"ZI_PREFERRED", -"ZI_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"zsOverride": { -"enum": [ -"ZS_UNSPECIFIED", -"ZS_UNKNOWN", -"ZS_NOT_REQUIRED", -"ZS_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, "RescheduleClusterMaintenanceRequest": { "description": "Request for rescheduling a cluster maintenance.", "id": "RescheduleClusterMaintenanceRequest", @@ -3913,6 +3667,7 @@ false "type": "integer" }, "retentionUnit": { +"deprecated": true, "description": "The unit that 'retained_backups' represents.", "enum": [ "RETENTION_UNIT_UNSPECIFIED", @@ -3933,26 +3688,11 @@ false "timeBasedRetention": { "format": "google-duration", "type": "string" -} -}, -"type": "object" }, -"SpannerLocation": { -"id": "SpannerLocation", -"properties": { -"backupName": { -"description": "Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata", -"items": { -"type": "string" -}, -"type": "array" -}, -"dbName": { -"description": "Set of databases used by the resource in format /span//", -"items": { +"timestampBasedRetentionTime": { +"description": "Timestamp based retention period i.e. 2024-05-01T00:00:00Z", +"format": "google-datetime", "type": "string" -}, -"type": "array" } }, "type": "object" @@ -4009,18 +3749,6 @@ false }, "type": "object" }, -"TenantProjectProxy": { -"id": "TenantProjectProxy", -"properties": { -"projectNumbers": { -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "TimeOfDay": { "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "id": "TimeOfDay", @@ -4186,15 +3914,6 @@ false }, "type": "object" }, -"ZoneConfiguration": { -"id": "ZoneConfiguration", -"properties": { -"zone": { -"type": "string" -} -}, -"type": "object" -}, "ZoneDistributionConfig": { "description": "Zone distribution config for allocation of cluster resources.", "id": "ZoneDistributionConfig", diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index 65e8f1a329..3bc937a583 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -849,7 +849,7 @@ } } }, -"revision": "20241003", +"revision": "20241017", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -875,42 +875,6 @@ }, "type": "object" }, -"AssetLocation": { -"description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", -"id": "AssetLocation", -"properties": { -"ccfeRmsPath": { -"description": "Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata.", -"type": "string" -}, -"expected": { -"$ref": "IsolationExpectations", -"description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." -}, -"extraParameters": { -"description": "Defines extra parameters required for specific asset types.", -"items": { -"$ref": "ExtraParameter" -}, -"type": "array" -}, -"locationData": { -"description": "Contains all kinds of physical location definitions for this asset.", -"items": { -"$ref": "LocationData" -}, -"type": "array" -}, -"parentAsset": { -"description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.", -"items": { -"$ref": "CloudAsset" -}, -"type": "array" -} -}, -"type": "object" -}, "AvailabilityConfiguration": { "description": "Configuration for availability of database instance", "id": "AvailabilityConfiguration", @@ -1004,19 +968,6 @@ }, "type": "object" }, -"BlobstoreLocation": { -"description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", -"id": "BlobstoreLocation", -"properties": { -"policyId": { -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "CertChain": { "id": "CertChain", "properties": { @@ -1044,30 +995,6 @@ }, "type": "object" }, -"CloudAsset": { -"id": "CloudAsset", -"properties": { -"assetName": { -"type": "string" -}, -"assetType": { -"type": "string" -} -}, -"type": "object" -}, -"CloudAssetComposition": { -"id": "CloudAssetComposition", -"properties": { -"childAsset": { -"items": { -"$ref": "CloudAsset" -}, -"type": "array" -} -}, -"type": "object" -}, "Cluster": { "description": "A cluster instance.", "id": "Cluster", @@ -1086,6 +1013,13 @@ ], "type": "string" }, +"clusterEndpoints": { +"description": "Optional. A list of cluster enpoints.", +"items": { +"$ref": "ClusterEndpoint" +}, +"type": "array" +}, "createTime": { "description": "Output only. The timestamp associated with the cluster creation request.", "format": "google-datetime", @@ -1150,7 +1084,7 @@ "type": "number" }, "pscConfigs": { -"description": "Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.", +"description": "Optional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.", "items": { "$ref": "PscConfig" }, @@ -1164,6 +1098,14 @@ "readOnly": true, "type": "array" }, +"pscServiceAttachments": { +"description": "Output only. Service attachment details to configure Psc connections", +"items": { +"$ref": "PscServiceAttachment" +}, +"readOnly": true, +"type": "array" +}, "redisConfigs": { "additionalProperties": { "type": "string" @@ -1237,6 +1179,20 @@ }, "type": "object" }, +"ClusterEndpoint": { +"description": "ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster.", +"id": "ClusterEndpoint", +"properties": { +"connections": { +"description": "A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster.", +"items": { +"$ref": "ConnectionDetail" +}, +"type": "array" +} +}, +"type": "object" +}, "ClusterMaintenancePolicy": { "description": "Maintenance policy per cluster.", "id": "ClusterMaintenancePolicy", @@ -1363,6 +1319,17 @@ }, "type": "object" }, +"ConnectionDetail": { +"description": "Detailed information of each PSC connection.", +"id": "ConnectionDetail", +"properties": { +"pscConnection": { +"$ref": "PscConnection", +"description": "Detailed information of a PSC connection that is created by the customer who owns the cluster." +} +}, +"type": "object" +}, "CrossClusterReplicationConfig": { "description": "Cross cluster replication config.", "id": "CrossClusterReplicationConfig", @@ -2360,18 +2327,6 @@ false }, "type": "object" }, -"DirectLocationAssignment": { -"id": "DirectLocationAssignment", -"properties": { -"location": { -"items": { -"$ref": "LocationAssignment" -}, -"type": "array" -} -}, -"type": "object" -}, "DiscoveryEndpoint": { "description": "Endpoints on each network, for Redis clients to connect to the cluster.", "id": "DiscoveryEndpoint", @@ -2445,17 +2400,6 @@ false }, "type": "object" }, -"ExtraParameter": { -"description": "Defines parameters that should only be used for specific asset types.", -"id": "ExtraParameter", -"properties": { -"regionalMigDistributionPolicy": { -"$ref": "RegionalMigDistributionPolicy", -"description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." -} -}, -"type": "object" -}, "FailoverInstanceRequest": { "description": "Request for Failover.", "id": "FailoverInstanceRequest", @@ -2884,131 +2828,6 @@ false }, "type": "object" }, -"IsolationExpectations": { -"id": "IsolationExpectations", -"properties": { -"requirementOverride": { -"$ref": "RequirementOverride", -"description": "Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic." -}, -"ziOrgPolicy": { -"enum": [ -"ZI_UNSPECIFIED", -"ZI_UNKNOWN", -"ZI_NOT_REQUIRED", -"ZI_PREFERRED", -"ZI_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"ziRegionPolicy": { -"enum": [ -"ZI_REGION_POLICY_UNSPECIFIED", -"ZI_REGION_POLICY_UNKNOWN", -"ZI_REGION_POLICY_NOT_SET", -"ZI_REGION_POLICY_FAIL_OPEN", -"ZI_REGION_POLICY_FAIL_CLOSED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"ziRegionState": { -"enum": [ -"ZI_REGION_UNSPECIFIED", -"ZI_REGION_UNKNOWN", -"ZI_REGION_NOT_ENABLED", -"ZI_REGION_ENABLED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -}, -"zoneIsolation": { -"deprecated": true, -"description": "Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location.", -"enum": [ -"ZI_UNSPECIFIED", -"ZI_UNKNOWN", -"ZI_NOT_REQUIRED", -"ZI_PREFERRED", -"ZI_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"zoneSeparation": { -"deprecated": true, -"description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.", -"enum": [ -"ZS_UNSPECIFIED", -"ZS_UNKNOWN", -"ZS_NOT_REQUIRED", -"ZS_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -}, -"zsOrgPolicy": { -"enum": [ -"ZS_UNSPECIFIED", -"ZS_UNKNOWN", -"ZS_NOT_REQUIRED", -"ZS_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -}, -"zsRegionState": { -"enum": [ -"ZS_REGION_UNSPECIFIED", -"ZS_REGION_UNKNOWN", -"ZS_REGION_NOT_ENABLED", -"ZS_REGION_ENABLED" -], -"enumDescriptions": [ -"", -"To be used if tracking of the asset ZS-bit is not available", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, "ListClustersResponse": { "description": "Response for ListClusters.", "id": "ListClustersResponse", @@ -3129,64 +2948,6 @@ false }, "type": "object" }, -"LocationAssignment": { -"id": "LocationAssignment", -"properties": { -"location": { -"type": "string" -}, -"locationType": { -"enum": [ -"UNSPECIFIED", -"CLUSTER", -"POP", -"CLOUD_ZONE", -"CLOUD_REGION", -"MULTI_REGION_GEO", -"MULTI_REGION_JURISDICTION", -"GLOBAL", -"OTHER" -], -"enumDescriptions": [ -"", -"1-10: Physical failure domains.", -"", -"11-20: Logical failure domains.", -"", -"", -"", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, -"LocationData": { -"id": "LocationData", -"properties": { -"blobstoreLocation": { -"$ref": "BlobstoreLocation" -}, -"childAssetLocation": { -"$ref": "CloudAssetComposition" -}, -"directLocation": { -"$ref": "DirectLocationAssignment" -}, -"gcpProjectProxy": { -"$ref": "TenantProjectProxy" -}, -"placerLocation": { -"$ref": "PlacerLocation" -}, -"spannerLocation": { -"$ref": "SpannerLocation" -} -}, -"type": "object" -}, "MachineConfiguration": { "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", "id": "MachineConfiguration", @@ -3552,17 +3313,6 @@ false }, "type": "object" }, -"PlacerLocation": { -"description": "Message describing that the location of the customer resource is tied to placer allocations", -"id": "PlacerLocation", -"properties": { -"placerConfig": { -"description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")", -"type": "string" -} -}, -"type": "object" -}, "Product": { "description": "Product specification for Condor resources.", "id": "Product", @@ -3696,6 +3446,23 @@ false "description": "Required. The IP allocated on the consumer network for the PSC forwarding rule.", "type": "string" }, +"connectionType": { +"description": "Output only. Type of the PSC connection.", +"enum": [ +"CONNECTION_TYPE_UNSPECIFIED", +"CONNECTION_TYPE_DISCOVERY", +"CONNECTION_TYPE_PRIMARY", +"CONNECTION_TYPE_READER" +], +"enumDescriptions": [ +"Cluster endpoint Type is not set", +"Cluster endpoint that will be used as for cluster topology discovery.", +"Cluster endpoint that will be used as primary endpoint to access primary.", +"Cluster endpoint that will be used as reader endpoint to access replicas." +], +"readOnly": true, +"type": "string" +}, "forwardingRule": { "description": "Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.", "type": "string" @@ -3712,6 +3479,21 @@ false "description": "Required. The PSC connection id of the forwarding rule connected to the service attachment.", "type": "string" }, +"pscConnectionStatus": { +"description": "Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details.", +"enum": [ +"PSC_CONNECTION_STATUS_UNSPECIFIED", +"PSC_CONNECTION_STATUS_ACTIVE", +"PSC_CONNECTION_STATUS_NOT_FOUND" +], +"enumDescriptions": [ +"PSC connection status is not specified.", +"The connection is active", +"Connection not found" +], +"readOnly": true, +"type": "string" +}, "serviceAttachment": { "description": "Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}.", "type": "string" @@ -3719,6 +3501,35 @@ false }, "type": "object" }, +"PscServiceAttachment": { +"description": "Configuration of a service attachment of the cluster, for creating PSC connections.", +"id": "PscServiceAttachment", +"properties": { +"connectionType": { +"description": "Output only. Type of a PSC connection targeting this service attachment.", +"enum": [ +"CONNECTION_TYPE_UNSPECIFIED", +"CONNECTION_TYPE_DISCOVERY", +"CONNECTION_TYPE_PRIMARY", +"CONNECTION_TYPE_READER" +], +"enumDescriptions": [ +"Cluster endpoint Type is not set", +"Cluster endpoint that will be used as for cluster topology discovery.", +"Cluster endpoint that will be used as primary endpoint to access primary.", +"Cluster endpoint that will be used as reader endpoint to access replicas." +], +"readOnly": true, +"type": "string" +}, +"serviceAttachment": { +"description": "Output only. Service attachment URI which your self-created PscConnection should use as target", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "RDBConfig": { "description": "Configuration of the RDB based persistence.", "id": "RDBConfig", @@ -3780,25 +3591,6 @@ false }, "type": "object" }, -"RegionalMigDistributionPolicy": { -"description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", -"id": "RegionalMigDistributionPolicy", -"properties": { -"targetShape": { -"description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum", -"format": "int32", -"type": "integer" -}, -"zones": { -"description": "Cloud zones used by regional MIG to create instances.", -"items": { -"$ref": "ZoneConfiguration" -}, -"type": "array" -} -}, -"type": "object" -}, "RemoteCluster": { "description": "Details of the remote cluster associated with this cluster in a cross cluster replication setup.", "id": "RemoteCluster", @@ -3815,44 +3607,6 @@ false }, "type": "object" }, -"RequirementOverride": { -"id": "RequirementOverride", -"properties": { -"ziOverride": { -"enum": [ -"ZI_UNSPECIFIED", -"ZI_UNKNOWN", -"ZI_NOT_REQUIRED", -"ZI_PREFERRED", -"ZI_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"zsOverride": { -"enum": [ -"ZS_UNSPECIFIED", -"ZS_UNKNOWN", -"ZS_NOT_REQUIRED", -"ZS_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, "RescheduleClusterMaintenanceRequest": { "description": "Request for rescheduling a cluster maintenance.", "id": "RescheduleClusterMaintenanceRequest", @@ -3920,6 +3674,7 @@ false "type": "integer" }, "retentionUnit": { +"deprecated": true, "description": "The unit that 'retained_backups' represents.", "enum": [ "RETENTION_UNIT_UNSPECIFIED", @@ -3940,26 +3695,11 @@ false "timeBasedRetention": { "format": "google-duration", "type": "string" -} -}, -"type": "object" }, -"SpannerLocation": { -"id": "SpannerLocation", -"properties": { -"backupName": { -"description": "Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata", -"items": { -"type": "string" -}, -"type": "array" -}, -"dbName": { -"description": "Set of databases used by the resource in format /span//", -"items": { +"timestampBasedRetentionTime": { +"description": "Timestamp based retention period i.e. 2024-05-01T00:00:00Z", +"format": "google-datetime", "type": "string" -}, -"type": "array" } }, "type": "object" @@ -4016,18 +3756,6 @@ false }, "type": "object" }, -"TenantProjectProxy": { -"id": "TenantProjectProxy", -"properties": { -"projectNumbers": { -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "TimeOfDay": { "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "id": "TimeOfDay", @@ -4193,15 +3921,6 @@ false }, "type": "object" }, -"ZoneConfiguration": { -"id": "ZoneConfiguration", -"properties": { -"zone": { -"type": "string" -} -}, -"type": "object" -}, "ZoneDistributionConfig": { "description": "Zone distribution config for allocation of cluster resources.", "id": "ZoneDistributionConfig", diff --git a/googleapiclient/discovery_cache/documents/retail.v2.json b/googleapiclient/discovery_cache/documents/retail.v2.json index c39e57d073..aa1043a6ea 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2.json +++ b/googleapiclient/discovery_cache/documents/retail.v2.json @@ -2246,7 +2246,7 @@ } } }, -"revision": "20241003", +"revision": "20241017", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6697,21 +6697,6 @@ "frequentlyBoughtTogetherConfig": { "$ref": "GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig", "description": "Additional configs for frequently-bought-together models." -}, -"llmEmbeddingConfig": { -"$ref": "GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig", -"description": "Optional. LLM embedding config to use for this model." -} -}, -"type": "object" -}, -"GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig": { -"description": "Config that turns on usage of llm embeddings as features to the model. Embeddings leverage unstructured text fields like description and title.", -"id": "GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig", -"properties": { -"llmEmbeddingVersion": { -"description": "Optional. The LLM embedding version to use. Currently only `v0` is supported. If not specified, feature will not be turned on.", -"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json index 234d883311..bb04cf309f 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json @@ -2767,7 +2767,7 @@ } } }, -"revision": "20241003", +"revision": "20241017", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5705,21 +5705,6 @@ "frequentlyBoughtTogetherConfig": { "$ref": "GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig", "description": "Additional configs for frequently-bought-together models." -}, -"llmEmbeddingConfig": { -"$ref": "GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig", -"description": "Optional. LLM embedding config to use for this model." -} -}, -"type": "object" -}, -"GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig": { -"description": "Config that turns on usage of llm embeddings as features to the model. Embeddings leverage unstructured text fields like description and title.", -"id": "GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig", -"properties": { -"llmEmbeddingVersion": { -"description": "Optional. The LLM embedding version to use. Currently only `v0` is supported. If not specified, feature will not be turned on.", -"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json index 1e8e836377..423297ace1 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2beta.json +++ b/googleapiclient/discovery_cache/documents/retail.v2beta.json @@ -2391,7 +2391,7 @@ } } }, -"revision": "20241003", +"revision": "20241017", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3662,21 +3662,6 @@ "frequentlyBoughtTogetherConfig": { "$ref": "GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig", "description": "Additional configs for frequently-bought-together models." -}, -"llmEmbeddingConfig": { -"$ref": "GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig", -"description": "Optional. LLM embedding config to use for this model." -} -}, -"type": "object" -}, -"GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig": { -"description": "Config that turns on usage of llm embeddings as features to the model. Embeddings leverage unstructured text fields like description and title.", -"id": "GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig", -"properties": { -"llmEmbeddingVersion": { -"description": "Optional. The LLM embedding version to use. Currently only `v0` is supported. If not specified, feature will not be turned on.", -"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index 3971407f11..9f74a3d114 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -1526,7 +1526,7 @@ } } }, -"revision": "20241004", +"revision": "20241011", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -3259,7 +3259,7 @@ "type": "string" }, "invokerIamDisabled": { -"description": "Optional. Disables IAM permission check for run.routes.invoke for callers of this service. This setting should not be used with external ingress.", +"description": "Optional. Disables IAM permission check for run.routes.invoke for callers of this service. This feature is available by invitation only. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check.", "type": "boolean" }, "labels": { diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1.json index 954af7dd4c..e1d53878fd 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1.json @@ -20,6 +20,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://securitycenter.me-central2.rep.googleapis.com/", "location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://securitycenter.us.rep.googleapis.com/", +"location": "us" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://securitycenter.eu.rep.googleapis.com/", +"location": "eu" } ], "fullyEncodeReservedExpansion": true, @@ -5877,7 +5887,7 @@ } } }, -"revision": "20240926", +"revision": "20241018", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -6601,17 +6611,6 @@ }, "type": "object" }, -"CelPolicySpec": { -"description": "YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: \"compute.googleapis.com/Instance\" - resource_types: \"compute.googleapis.com/Firewall\" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies.", -"id": "CelPolicySpec", -"properties": { -"spec": { -"description": "The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false.", -"type": "string" -} -}, -"type": "object" -}, "CloudArmor": { "description": "Fields related to Google Cloud Armor findings.", "id": "CloudArmor", @@ -8050,10 +8049,6 @@ "description": "Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify.", "id": "GoogleCloudSecuritycenterV1CustomConfig", "properties": { -"celPolicy": { -"$ref": "CelPolicySpec", -"description": "The CEL policy spec attached to the custom module." -}, "customOutput": { "$ref": "GoogleCloudSecuritycenterV1CustomOutputSpec", "description": "Custom output properties." @@ -10760,6 +10755,7 @@ "ACCOUNT_ACCESS_REMOVAL", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", +"EVENT_TRIGGERED_EXECUTION", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", "MODIFY_AUTHENTICATION_PROCESS", @@ -10776,6 +10772,7 @@ "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "CONTAINER_ADMINISTRATION_COMMAND", +"DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" @@ -10827,6 +10824,7 @@ "T1531", "T1539", "T1543", +"T1546", "T1548", "T1552", "T1556", @@ -10843,6 +10841,7 @@ "T1595", "T1595.001", "T1609", +"T1610", "T1611", "T1613", "T1649" @@ -10939,6 +10938,7 @@ "ACCOUNT_ACCESS_REMOVAL", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", +"EVENT_TRIGGERED_EXECUTION", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", "MODIFY_AUTHENTICATION_PROCESS", @@ -10955,6 +10955,7 @@ "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "CONTAINER_ADMINISTRATION_COMMAND", +"DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" @@ -11006,6 +11007,7 @@ "T1531", "T1539", "T1543", +"T1546", "T1548", "T1552", "T1556", @@ -11022,6 +11024,7 @@ "T1595", "T1595.001", "T1609", +"T1610", "T1611", "T1613", "T1649" @@ -12828,6 +12831,7 @@ "ACCOUNT_ACCESS_REMOVAL", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", +"EVENT_TRIGGERED_EXECUTION", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", "MODIFY_AUTHENTICATION_PROCESS", @@ -12844,6 +12848,7 @@ "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "CONTAINER_ADMINISTRATION_COMMAND", +"DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" @@ -12895,6 +12900,7 @@ "T1531", "T1539", "T1543", +"T1546", "T1548", "T1552", "T1556", @@ -12911,6 +12917,7 @@ "T1595", "T1595.001", "T1609", +"T1610", "T1611", "T1613", "T1649" @@ -13007,6 +13014,7 @@ "ACCOUNT_ACCESS_REMOVAL", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", +"EVENT_TRIGGERED_EXECUTION", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", "MODIFY_AUTHENTICATION_PROCESS", @@ -13023,6 +13031,7 @@ "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "CONTAINER_ADMINISTRATION_COMMAND", +"DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" @@ -13074,6 +13083,7 @@ "T1531", "T1539", "T1543", +"T1546", "T1548", "T1552", "T1556", @@ -13090,6 +13100,7 @@ "T1595", "T1595.001", "T1609", +"T1610", "T1611", "T1613", "T1649" @@ -13925,7 +13936,7 @@ "id": "SetFindingStateRequest", "properties": { "startTime": { -"description": "Required. The time at which the updated state takes effect.", +"description": "Optional. The time at which the updated state takes effect. If unset, defaults to the request time.", "format": "google-datetime", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json index eccb9c40d1..fd18d145c8 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json @@ -20,6 +20,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://securitycenter.me-central2.rep.googleapis.com/", "location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://securitycenter.us.rep.googleapis.com/", +"location": "us" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://securitycenter.eu.rep.googleapis.com/", +"location": "eu" } ], "fullyEncodeReservedExpansion": true, @@ -903,7 +913,7 @@ } } }, -"revision": "20240926", +"revision": "20241018", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -1439,17 +1449,6 @@ "properties": {}, "type": "object" }, -"CelPolicySpec": { -"description": "YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: \"compute.googleapis.com/Instance\" - resource_types: \"compute.googleapis.com/Firewall\" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies.", -"id": "CelPolicySpec", -"properties": { -"spec": { -"description": "The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false.", -"type": "string" -} -}, -"type": "object" -}, "CloudArmor": { "description": "Fields related to Google Cloud Armor findings.", "id": "CloudArmor", @@ -2723,10 +2722,6 @@ "description": "Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify.", "id": "GoogleCloudSecuritycenterV1CustomConfig", "properties": { -"celPolicy": { -"$ref": "CelPolicySpec", -"description": "The CEL policy spec attached to the custom module." -}, "customOutput": { "$ref": "GoogleCloudSecuritycenterV1CustomOutputSpec", "description": "Custom output properties." @@ -5514,6 +5509,7 @@ "ACCOUNT_ACCESS_REMOVAL", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", +"EVENT_TRIGGERED_EXECUTION", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", "MODIFY_AUTHENTICATION_PROCESS", @@ -5530,6 +5526,7 @@ "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "CONTAINER_ADMINISTRATION_COMMAND", +"DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" @@ -5581,6 +5578,7 @@ "T1531", "T1539", "T1543", +"T1546", "T1548", "T1552", "T1556", @@ -5597,6 +5595,7 @@ "T1595", "T1595.001", "T1609", +"T1610", "T1611", "T1613", "T1649" @@ -5693,6 +5692,7 @@ "ACCOUNT_ACCESS_REMOVAL", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", +"EVENT_TRIGGERED_EXECUTION", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", "MODIFY_AUTHENTICATION_PROCESS", @@ -5709,6 +5709,7 @@ "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "CONTAINER_ADMINISTRATION_COMMAND", +"DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" @@ -5760,6 +5761,7 @@ "T1531", "T1539", "T1543", +"T1546", "T1548", "T1552", "T1556", @@ -5776,6 +5778,7 @@ "T1595", "T1595.001", "T1609", +"T1610", "T1611", "T1613", "T1649" @@ -7303,6 +7306,7 @@ "ACCOUNT_ACCESS_REMOVAL", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", +"EVENT_TRIGGERED_EXECUTION", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", "MODIFY_AUTHENTICATION_PROCESS", @@ -7319,6 +7323,7 @@ "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "CONTAINER_ADMINISTRATION_COMMAND", +"DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" @@ -7370,6 +7375,7 @@ "T1531", "T1539", "T1543", +"T1546", "T1548", "T1552", "T1556", @@ -7386,6 +7392,7 @@ "T1595", "T1595.001", "T1609", +"T1610", "T1611", "T1613", "T1649" @@ -7482,6 +7489,7 @@ "ACCOUNT_ACCESS_REMOVAL", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", +"EVENT_TRIGGERED_EXECUTION", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", "MODIFY_AUTHENTICATION_PROCESS", @@ -7498,6 +7506,7 @@ "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "CONTAINER_ADMINISTRATION_COMMAND", +"DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" @@ -7549,6 +7558,7 @@ "T1531", "T1539", "T1543", +"T1546", "T1548", "T1552", "T1556", @@ -7565,6 +7575,7 @@ "T1595", "T1595.001", "T1609", +"T1610", "T1611", "T1613", "T1649" diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json index 1dceb3abbc..903be75280 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json @@ -20,6 +20,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://securitycenter.me-central2.rep.googleapis.com/", "location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://securitycenter.us.rep.googleapis.com/", +"location": "us" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://securitycenter.eu.rep.googleapis.com/", +"location": "eu" } ], "fullyEncodeReservedExpansion": true, @@ -1993,7 +2003,7 @@ } } }, -"revision": "20241004", +"revision": "20241018", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2389,17 +2399,6 @@ }, "type": "object" }, -"CelPolicySpec": { -"description": "YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: \"compute.googleapis.com/Instance\" - resource_types: \"compute.googleapis.com/Firewall\" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies.", -"id": "CelPolicySpec", -"properties": { -"spec": { -"description": "The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false.", -"type": "string" -} -}, -"type": "object" -}, "CloudArmor": { "description": "Fields related to Google Cloud Armor findings.", "id": "CloudArmor", @@ -3797,10 +3796,6 @@ "description": "Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify.", "id": "GoogleCloudSecuritycenterV1CustomConfig", "properties": { -"celPolicy": { -"$ref": "CelPolicySpec", -"description": "The CEL policy spec attached to the custom module." -}, "customOutput": { "$ref": "GoogleCloudSecuritycenterV1CustomOutputSpec", "description": "Custom output properties." @@ -6507,6 +6502,7 @@ "ACCOUNT_ACCESS_REMOVAL", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", +"EVENT_TRIGGERED_EXECUTION", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", "MODIFY_AUTHENTICATION_PROCESS", @@ -6523,6 +6519,7 @@ "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "CONTAINER_ADMINISTRATION_COMMAND", +"DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" @@ -6574,6 +6571,7 @@ "T1531", "T1539", "T1543", +"T1546", "T1548", "T1552", "T1556", @@ -6590,6 +6588,7 @@ "T1595", "T1595.001", "T1609", +"T1610", "T1611", "T1613", "T1649" @@ -6686,6 +6685,7 @@ "ACCOUNT_ACCESS_REMOVAL", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", +"EVENT_TRIGGERED_EXECUTION", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", "MODIFY_AUTHENTICATION_PROCESS", @@ -6702,6 +6702,7 @@ "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "CONTAINER_ADMINISTRATION_COMMAND", +"DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" @@ -6753,6 +6754,7 @@ "T1531", "T1539", "T1543", +"T1546", "T1548", "T1552", "T1556", @@ -6769,6 +6771,7 @@ "T1595", "T1595.001", "T1609", +"T1610", "T1611", "T1613", "T1649" @@ -8047,6 +8050,7 @@ "ACCOUNT_ACCESS_REMOVAL", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", +"EVENT_TRIGGERED_EXECUTION", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", "MODIFY_AUTHENTICATION_PROCESS", @@ -8063,6 +8067,7 @@ "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "CONTAINER_ADMINISTRATION_COMMAND", +"DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" @@ -8114,6 +8119,7 @@ "T1531", "T1539", "T1543", +"T1546", "T1548", "T1552", "T1556", @@ -8130,6 +8136,7 @@ "T1595", "T1595.001", "T1609", +"T1610", "T1611", "T1613", "T1649" @@ -8226,6 +8233,7 @@ "ACCOUNT_ACCESS_REMOVAL", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", +"EVENT_TRIGGERED_EXECUTION", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", "MODIFY_AUTHENTICATION_PROCESS", @@ -8242,6 +8250,7 @@ "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "CONTAINER_ADMINISTRATION_COMMAND", +"DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" @@ -8293,6 +8302,7 @@ "T1531", "T1539", "T1543", +"T1546", "T1548", "T1552", "T1556", @@ -8309,6 +8319,7 @@ "T1595", "T1595.001", "T1609", +"T1610", "T1611", "T1613", "T1649" diff --git a/googleapiclient/discovery_cache/documents/sheets.v4.json b/googleapiclient/discovery_cache/documents/sheets.v4.json index 4123fcef3b..9c89636918 100644 --- a/googleapiclient/discovery_cache/documents/sheets.v4.json +++ b/googleapiclient/discovery_cache/documents/sheets.v4.json @@ -870,7 +870,7 @@ } } }, -"revision": "20241001", +"revision": "20241008", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { @@ -7182,22 +7182,22 @@ "id": "TimeOfDay", "properties": { "hours": { -"description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", +"description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, "minutes": { -"description": "Minutes of hour of day. Must be from 0 to 59.", +"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "type": "integer" }, "nanos": { -"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", +"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32", "type": "integer" }, "seconds": { -"description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", +"description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json index d2eedc05c4..a3e34f2a1e 100644 --- a/googleapiclient/discovery_cache/documents/spanner.v1.json +++ b/googleapiclient/discovery_cache/documents/spanner.v1.json @@ -39,6 +39,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://spanner.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://spanner.us-east1.rep.googleapis.com/", "location": "us-east1" }, @@ -54,6 +59,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://spanner.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://spanner.us-south1.rep.googleapis.com/", "location": "us-south1" }, @@ -69,6 +79,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://spanner.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://spanner.us-west4.rep.googleapis.com/", "location": "us-west4" }, @@ -3304,13 +3319,35 @@ } } }, -"revision": "20240930", +"revision": "20241018", "rootUrl": "https://spanner.googleapis.com/", "schemas": { +"AsymmetricAutoscalingOption": { +"description": "AsymmetricAutoscalingOption specifies the scaling of replicas identified by the given selection.", +"id": "AsymmetricAutoscalingOption", +"properties": { +"overrides": { +"$ref": "AutoscalingConfigOverrides", +"description": "Optional. Overrides applied to the top-level autoscaling configuration for the selected replicas." +}, +"replicaSelection": { +"$ref": "InstanceReplicaSelection", +"description": "Required. Selects the replicas to which this AsymmetricAutoscalingOption applies. Only read-only replicas are supported." +} +}, +"type": "object" +}, "AutoscalingConfig": { "description": "Autoscaling configuration for an instance.", "id": "AutoscalingConfig", "properties": { +"asymmetricAutoscalingOptions": { +"description": "Optional. Optional asymmetric autoscaling options. Replicas matching the replica selection criteria will be autoscaled independently from other replicas. The autoscaler will scale the replicas based on the utilization of replicas identified by the replica selection. Replica selections should not overlap with each other. Other replicas (those do not match any replica selection) will be autoscaled together and will have the same compute capacity allocated to them.", +"items": { +"$ref": "AsymmetricAutoscalingOption" +}, +"type": "array" +}, "autoscalingLimits": { "$ref": "AutoscalingLimits", "description": "Required. Autoscaling limits for an instance." @@ -3322,6 +3359,22 @@ }, "type": "object" }, +"AutoscalingConfigOverrides": { +"description": "Overrides the top-level autoscaling configuration for the replicas identified by `replica_selection`. All fields in this message are optional. Any unspecified fields will use the corresponding values from the top-level autoscaling configuration.", +"id": "AutoscalingConfigOverrides", +"properties": { +"autoscalingLimits": { +"$ref": "AutoscalingLimits", +"description": "Optional. If specified, overrides the min/max limit in the top-level autoscaling configuration for the selected replicas." +}, +"autoscalingTargetHighPriorityCpuUtilizationPercent": { +"description": "Optional. If specified, overrides the autoscaling target high_priority_cpu_utilization_percent in the top-level autoscaling configuration for the selected replicas.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "AutoscalingLimits": { "description": "The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit.", "id": "AutoscalingLimits", @@ -4582,12 +4635,16 @@ "enum": [ "NORMAL", "PLAN", -"PROFILE" +"PROFILE", +"WITH_STATS", +"WITH_PLAN_AND_STATS" ], "enumDescriptions": [ "The default mode. Only the statement results are returned.", "This mode returns only the query plan, without any results or execution statistics information.", -"This mode returns the query plan, overall execution statistics, operator level execution statistics along with the results. This has a performance overhead compared to the other modes. It is not recommended to use this mode for production traffic." +"This mode returns the query plan, overall execution statistics, operator level execution statistics along with the results. This has a performance overhead compared to the other modes. It is not recommended to use this mode for production traffic.", +"This mode returns the overall (but not operator-level) execution statistics along with the results.", +"This mode returns the query plan, overall (but not operator-level) execution statistics along with the results." ], "type": "string" }, @@ -4886,15 +4943,23 @@ "type": "string" }, "nodeCount": { -"description": "The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity).", +"description": "The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying node count across replicas (achieved by setting asymmetric_autoscaling_options in autoscaling config), the node_count here is the maximum node count across all replicas. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity).", "format": "int32", "type": "integer" }, "processingUnits": { -"description": "The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity).", +"description": "The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. If the instance has varying processing units per replica (achieved by setting asymmetric_autoscaling_options in autoscaling config), the processing_units here is the maximum processing units across all replicas. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity).", "format": "int32", "type": "integer" }, +"replicaComputeCapacity": { +"description": "Output only. Lists the compute capacity per ReplicaSelection. A replica selection identifies a set of replicas with common properties. Replicas identified by a ReplicaSelection are scaled with the same compute capacity.", +"items": { +"$ref": "ReplicaComputeCapacity" +}, +"readOnly": true, +"type": "array" +}, "state": { "description": "Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`.", "enum": [ @@ -5147,6 +5212,17 @@ }, "type": "object" }, +"InstanceReplicaSelection": { +"description": "ReplicaSelection identifies replicas with common properties.", +"id": "InstanceReplicaSelection", +"properties": { +"location": { +"description": "Required. Name of the location of the replicas (e.g., \"us-central1\").", +"type": "string" +} +}, +"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", @@ -6321,6 +6397,27 @@ }, "type": "object" }, +"ReplicaComputeCapacity": { +"description": "ReplicaComputeCapacity describes the amount of server resources that are allocated to each replica identified by the replica selection.", +"id": "ReplicaComputeCapacity", +"properties": { +"nodeCount": { +"description": "The number of nodes allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`.", +"format": "int32", +"type": "integer" +}, +"processingUnits": { +"description": "The number of processing units allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`.", +"format": "int32", +"type": "integer" +}, +"replicaSelection": { +"$ref": "InstanceReplicaSelection", +"description": "Required. Identifies replicas by specified properties. All replicas in the selection have the same amount of compute capacity." +} +}, +"type": "object" +}, "ReplicaInfo": { "id": "ReplicaInfo", "properties": { @@ -6927,7 +7024,8 @@ "NUMERIC", "JSON", "PROTO", -"ENUM" +"ENUM", +"INTERVAL" ], "enumDescriptions": [ "Not specified.", @@ -6944,7 +7042,8 @@ "Encoded as `string`, in decimal format or scientific notation format. Decimal format: `[+-]Digits[.[Digits]]` or `+-.Digits` Scientific notation: `[+-]Digits[.[Digits]][ExponentIndicator[+-]Digits]` or `+-.Digits[ExponentIndicator[+-]Digits]` (ExponentIndicator is `\"e\"` or `\"E\"`)", "Encoded as a JSON-formatted `string` as described in RFC 7159. The following rules are applied when parsing JSON input: - Whitespace characters are not preserved. - If a JSON object has duplicate keys, only the first key is preserved. - Members of a JSON object are not guaranteed to have their order preserved. - JSON array elements will have their order preserved.", "Encoded as a base64-encoded `string`, as described in RFC 4648, section 4.", -"Encoded as `string`, in decimal format." +"Encoded as `string`, in decimal format.", +"Encoded as `string`, in `ISO8601` duration format - `P[n]Y[n]M[n]DT[n]H[n]M[n[.fraction]]S` where `n` is an integer. For example, `P1Y2M3DT4H5M6.5S` represents time duration of 1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6.5 seconds." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json index dc0ac072ae..4bb03936eb 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json @@ -609,7 +609,7 @@ "instances": { "methods": { "ListServerCertificates": { -"description": "Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.", +"description": "Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out. For instances not using Certificate Authority Service (CAS) server CA, use ListServerCas instead.", "flatPath": "v1/projects/{project}/instances/{instance}/listServerCertificates", "httpMethod": "GET", "id": "sql.instances.ListServerCertificates", @@ -2366,7 +2366,7 @@ } } }, -"revision": "20241004", +"revision": "20241011", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -5831,7 +5831,8 @@ true "UNSUPPORTED_COLUMNS", "USERS_NOT_CREATED_IN_REPLICA", "UNSUPPORTED_SYSTEM_OBJECTS", -"UNSUPPORTED_TABLES_WITH_REPLICA_IDENTITY" +"UNSUPPORTED_TABLES_WITH_REPLICA_IDENTITY", +"SELECTED_OBJECTS_NOT_EXIST_ON_SOURCE" ], "enumDescriptions": [ "", @@ -5886,7 +5887,8 @@ true "The source database has generated columns that can't be migrated. Please change them to regular columns before migration.", "The source database has users that aren't created in the replica. First, create all users, which are in the pg_user_mappings table of the source database, in the destination instance. Then, perform the migration.", "The selected objects include system objects that aren't supported for migration.", -"The source database has tables with the FULL or NOTHING replica identity. Before starting your migration, either remove the identity or change it to DEFAULT. Note that this is an error and will block the migration." +"The source database has tables with the FULL or NOTHING replica identity. Before starting your migration, either remove the identity or change it to DEFAULT. Note that this is an error and will block the migration.", +"The selected objects don't exist on the source instance." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json index dc1b0db6dd..c1b17b19c2 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json @@ -609,7 +609,7 @@ "instances": { "methods": { "ListServerCertificates": { -"description": "Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.", +"description": "Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out. For instances not using Certificate Authority Service (CAS) server CA, use ListServerCas instead.", "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/listServerCertificates", "httpMethod": "GET", "id": "sql.instances.ListServerCertificates", @@ -2378,7 +2378,7 @@ } } }, -"revision": "20241004", +"revision": "20241011", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -5844,7 +5844,8 @@ true "UNSUPPORTED_COLUMNS", "USERS_NOT_CREATED_IN_REPLICA", "UNSUPPORTED_SYSTEM_OBJECTS", -"UNSUPPORTED_TABLES_WITH_REPLICA_IDENTITY" +"UNSUPPORTED_TABLES_WITH_REPLICA_IDENTITY", +"SELECTED_OBJECTS_NOT_EXIST_ON_SOURCE" ], "enumDescriptions": [ "", @@ -5899,7 +5900,8 @@ true "The source database has generated columns that can't be migrated. Please change them to regular columns before migration.", "The source database has users that aren't created in the replica. First, create all users, which are in the pg_user_mappings table of the source database, in the destination instance. Then, perform the migration.", "The selected objects include system objects that aren't supported for migration.", -"The source database has tables with the FULL or NOTHING replica identity. Before starting your migration, either remove the identity or change it to DEFAULT. Note that this is an error and will block the migration." +"The source database has tables with the FULL or NOTHING replica identity. Before starting your migration, either remove the identity or change it to DEFAULT. Note that this is an error and will block the migration.", +"The selected objects don't exist on the source instance." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1.json index bb71f9b6de..e7d2bc6d72 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1.json @@ -294,24 +294,6 @@ }, "voices": { "methods": { -"generateVoiceCloningKey": { -"description": "Generates voice clone key given a short voice prompt. This method validates the voice prompts with a series of checks against the voice talent statement to verify the voice clone is safe to generate.", -"flatPath": "v1/voices:generateVoiceCloningKey", -"httpMethod": "POST", -"id": "texttospeech.voices.generateVoiceCloningKey", -"parameterOrder": [], -"parameters": {}, -"path": "v1/voices:generateVoiceCloningKey", -"request": { -"$ref": "GenerateVoiceCloningKeyRequest" -}, -"response": { -"$ref": "GenerateVoiceCloningKeyResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "list": { "description": "Returns a list of Voice supported for synthesis.", "flatPath": "v1/voices", @@ -336,7 +318,7 @@ } } }, -"revision": "20241001", +"revision": "20241026", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AdvancedVoiceOptions": { @@ -344,7 +326,7 @@ "id": "AdvancedVoiceOptions", "properties": { "lowLatencyJourneySynthesis": { -"description": "Only for Jounrney voices. If false, the synthesis will be context aware and have higher latency.", +"description": "Only for Journey voices. If false, the synthesis will be context aware and have higher latency.", "type": "boolean" } }, @@ -485,40 +467,6 @@ "properties": {}, "type": "object" }, -"GenerateVoiceCloningKeyRequest": { -"description": "Request message for the `GenerateVoiceCloningKey` method.", -"id": "GenerateVoiceCloningKeyRequest", -"properties": { -"consentScript": { -"description": "Required. The script used for the voice talent statement. The script will be provided to the caller through other channels. It must be returned unchanged in this field.", -"type": "string" -}, -"languageCode": { -"description": "Required. The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\". See [Language Support](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes.", -"type": "string" -}, -"referenceAudio": { -"$ref": "InputAudio", -"description": "Required. The training audio used to create voice clone. This is currently limited to LINEAR16 PCM WAV files mono audio with 24khz sample rate. This needs to be specified in [InputAudio.audio_config], other values will be explicitly rejected." -}, -"voiceTalentConsent": { -"$ref": "InputAudio", -"description": "Required. The voice talent audio used to verify consent to voice clone." -} -}, -"type": "object" -}, -"GenerateVoiceCloningKeyResponse": { -"description": "Response message for the `GenerateVoiceCloningKey` method.", -"id": "GenerateVoiceCloningKeyResponse", -"properties": { -"voiceCloningKey": { -"description": "The voice clone key. Use it in the SynthesizeSpeechRequest by setting [voice.voice_clone.voice_cloning_key].", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudTexttospeechV1SynthesizeLongAudioMetadata": { "description": "Metadata for response returned by the `SynthesizeLongAudio` method.", "id": "GoogleCloudTexttospeechV1SynthesizeLongAudioMetadata", @@ -542,54 +490,6 @@ }, "type": "object" }, -"InputAudio": { -"description": "Holds audio content and config.", -"id": "InputAudio", -"properties": { -"audioConfig": { -"$ref": "InputAudioConfig", -"description": "Required. Provides information that specifies how to process content." -}, -"content": { -"description": "Required. The audio data bytes encoded as specified in `InputAudioConfig`. Note: as with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64. Audio samples should be between 5-25 seconds in length.", -"format": "byte", -"type": "string" -} -}, -"type": "object" -}, -"InputAudioConfig": { -"description": "Description of inputted audio data.", -"id": "InputAudioConfig", -"properties": { -"audioEncoding": { -"description": "Required. The format of the audio byte stream.", -"enum": [ -"AUDIO_ENCODING_UNSPECIFIED", -"LINEAR16", -"MP3", -"OGG_OPUS", -"MULAW", -"ALAW" -], -"enumDescriptions": [ -"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.", -"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." -], -"type": "string" -}, -"sampleRateHertz": { -"description": "Required. The sample rate (in hertz) for this audio.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse", @@ -622,6 +522,20 @@ }, "type": "object" }, +"MultiSpeakerMarkup": { +"description": "A collection of turns for multi-speaker synthesis.", +"id": "MultiSpeakerMarkup", +"properties": { +"turns": { +"description": "Required. Speaker turns.", +"items": { +"$ref": "Turn" +}, +"type": "array" +} +}, +"type": "object" +}, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -692,6 +606,10 @@ "$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)." }, +"multiSpeakerMarkup": { +"$ref": "MultiSpeakerMarkup", +"description": "The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis." +}, "ssml": { "description": "The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml).", "type": "string" @@ -755,7 +673,7 @@ "properties": { "advancedVoiceOptions": { "$ref": "AdvancedVoiceOptions", -"description": "Adnanced voice options." +"description": "Advanced voice options." }, "audioConfig": { "$ref": "AudioConfig", @@ -784,6 +702,21 @@ }, "type": "object" }, +"Turn": { +"description": "A Multi-speaker turn.", +"id": "Turn", +"properties": { +"speaker": { +"description": "Required. The speaker of the turn, for example, 'O' or 'Q'. Please refer to documentation for available speakers.", +"type": "string" +}, +"text": { +"description": "Required. The text to speak.", +"type": "string" +} +}, +"type": "object" +}, "Voice": { "description": "Description of a voice supported by the TTS service.", "id": "Voice", diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json index 5c3893e659..29157a8203 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json @@ -237,24 +237,6 @@ }, "voices": { "methods": { -"generateVoiceCloningKey": { -"description": "Generates voice clone key given a short voice prompt. This method validates the voice prompts with a series of checks against the voice talent statement to verify the voice clone is safe to generate.", -"flatPath": "v1beta1/voices:generateVoiceCloningKey", -"httpMethod": "POST", -"id": "texttospeech.voices.generateVoiceCloningKey", -"parameterOrder": [], -"parameters": {}, -"path": "v1beta1/voices:generateVoiceCloningKey", -"request": { -"$ref": "GenerateVoiceCloningKeyRequest" -}, -"response": { -"$ref": "GenerateVoiceCloningKeyResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "list": { "description": "Returns a list of Voice supported for synthesis.", "flatPath": "v1beta1/voices", @@ -279,7 +261,7 @@ } } }, -"revision": "20241001", +"revision": "20241026", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AdvancedVoiceOptions": { @@ -287,7 +269,7 @@ "id": "AdvancedVoiceOptions", "properties": { "lowLatencyJourneySynthesis": { -"description": "Only for Jounrney voices. If false, the synthesis will be context aware and have higher latency.", +"description": "Only for Journey voices. If false, the synthesis will be context aware and have higher latency.", "type": "boolean" } }, @@ -418,40 +400,6 @@ }, "type": "object" }, -"GenerateVoiceCloningKeyRequest": { -"description": "Request message for the `GenerateVoiceCloningKey` method.", -"id": "GenerateVoiceCloningKeyRequest", -"properties": { -"consentScript": { -"description": "Required. The script used for the voice talent statement. The script will be provided to the caller through other channels. It must be returned unchanged in this field.", -"type": "string" -}, -"languageCode": { -"description": "Required. The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\". See [Language Support](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes.", -"type": "string" -}, -"referenceAudio": { -"$ref": "InputAudio", -"description": "Required. The training audio used to create voice clone. This is currently limited to LINEAR16 PCM WAV files mono audio with 24khz sample rate. This needs to be specified in [InputAudio.audio_config], other values will be explicitly rejected." -}, -"voiceTalentConsent": { -"$ref": "InputAudio", -"description": "Required. The voice talent audio used to verify consent to voice clone." -} -}, -"type": "object" -}, -"GenerateVoiceCloningKeyResponse": { -"description": "Response message for the `GenerateVoiceCloningKey` method.", -"id": "GenerateVoiceCloningKeyResponse", -"properties": { -"voiceCloningKey": { -"description": "The voice clone key. Use it in the SynthesizeSpeechRequest by setting [voice.voice_clone.voice_cloning_key].", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudTexttospeechV1beta1SynthesizeLongAudioMetadata": { "description": "Metadata for response returned by the `SynthesizeLongAudio` method.", "id": "GoogleCloudTexttospeechV1beta1SynthesizeLongAudioMetadata", @@ -475,56 +423,6 @@ }, "type": "object" }, -"InputAudio": { -"description": "Holds audio content and config.", -"id": "InputAudio", -"properties": { -"audioConfig": { -"$ref": "InputAudioConfig", -"description": "Required. Provides information that specifies how to process content." -}, -"content": { -"description": "Required. The audio data bytes encoded as specified in `InputAudioConfig`. Note: as with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64. Audio samples should be between 5-25 seconds in length.", -"format": "byte", -"type": "string" -} -}, -"type": "object" -}, -"InputAudioConfig": { -"description": "Description of inputted audio data.", -"id": "InputAudioConfig", -"properties": { -"audioEncoding": { -"description": "Required. The format of the audio byte stream.", -"enum": [ -"AUDIO_ENCODING_UNSPECIFIED", -"LINEAR16", -"MP3", -"MP3_64_KBPS", -"OGG_OPUS", -"MULAW", -"ALAW" -], -"enumDescriptions": [ -"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.", -"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.", -"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." -], -"type": "string" -}, -"sampleRateHertz": { -"description": "Required. The sample rate (in hertz) for this audio.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse", @@ -557,6 +455,20 @@ }, "type": "object" }, +"MultiSpeakerMarkup": { +"description": "A collection of turns for multi-speaker synthesis.", +"id": "MultiSpeakerMarkup", +"properties": { +"turns": { +"description": "Required. Speaker turns.", +"items": { +"$ref": "Turn" +}, +"type": "array" +} +}, +"type": "object" +}, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -627,6 +539,10 @@ "$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)." }, +"multiSpeakerMarkup": { +"$ref": "MultiSpeakerMarkup", +"description": "The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis." +}, "ssml": { "description": "The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml).", "type": "string" @@ -690,7 +606,7 @@ "properties": { "advancedVoiceOptions": { "$ref": "AdvancedVoiceOptions", -"description": "Adnanced voice options." +"description": "Advanced voice options." }, "audioConfig": { "$ref": "AudioConfig", @@ -761,6 +677,21 @@ }, "type": "object" }, +"Turn": { +"description": "A Multi-speaker turn.", +"id": "Turn", +"properties": { +"speaker": { +"description": "Required. The speaker of the turn, for example, 'O' or 'Q'. Please refer to documentation for available speakers.", +"type": "string" +}, +"text": { +"description": "Required. The text to speak.", +"type": "string" +} +}, +"type": "object" +}, "Voice": { "description": "Description of a voice supported by the TTS service.", "id": "Voice", diff --git a/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json b/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json index 7ac0b908f3..a9159f4139 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +++ b/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json @@ -965,7 +965,7 @@ } } }, -"revision": "20241009", +"revision": "20241017", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1461,6 +1461,20 @@ "nodeIdPrefix": { "description": "Prefix of node_ids in case of multi-node request Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format. If node_count = 3 and node_id_prefix = \"np\", node ids of nodes created will be \"np-0\", \"np-1\", \"np-2\". If this field is not provided we use queued_resource_id as the node_id_prefix.", "type": "string" +}, +"workloadType": { +"description": "Optional. The workload type for the multi-node request.", +"enum": [ +"WORKLOAD_TYPE_UNSPECIFIED", +"THROUGHPUT_OPTIMIZED", +"AVAILABILITY_OPTIMIZED" +], +"enumDescriptions": [ +"Not specified.", +"All of the nodes are available most of the time. Recommended for training workloads.", +"Most of the nodes are available all of the time. Recommended for serving workloads." +], +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/transcoder.v1.json b/googleapiclient/discovery_cache/documents/transcoder.v1.json index fe68cc0652..9f827f0e14 100644 --- a/googleapiclient/discovery_cache/documents/transcoder.v1.json +++ b/googleapiclient/discovery_cache/documents/transcoder.v1.json @@ -385,7 +385,7 @@ } } }, -"revision": "20240626", +"revision": "20241009", "rootUrl": "https://transcoder.googleapis.com/", "schemas": { "AdBreak": { @@ -565,7 +565,7 @@ "type": "array" }, "codec": { -"description": "The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3`", +"description": "The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` - `vorbis`", "type": "string" }, "displayName": { @@ -1486,7 +1486,7 @@ "id": "MuxStream", "properties": { "container": { -"description": "The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats)", +"description": "The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` - `ogg` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats)", "type": "string" }, "elementaryStreams": { diff --git a/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json b/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json index 7a0cfc47e1..474501f17b 100644 --- a/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +++ b/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json @@ -116,7 +116,7 @@ } } }, -"revision": "20240707", +"revision": "20241027", "rootUrl": "https://travelimpactmodel.googleapis.com/", "schemas": { "ComputeFlightEmissionsRequest": { @@ -234,7 +234,7 @@ "properties": { "emissionsGramsPerPax": { "$ref": "EmissionsGramsPerPax", -"description": "Optional. Per-passenger emission estimate numbers. Will not be present if emissions could not be computed. For the list of reasons why emissions could not be computed, see ComputeFlightEmissions. Note this field is currently equivalent to ttw_emissions_grams_per_pax until TIM version 1.X.0 which will update this to be total wtw emissions aka wtt_emissions_grams_per_pax + ttw_emissions_grams_per_pax." +"description": "Optional. Per-passenger emission estimate numbers. Will not be present if emissions could not be computed. For the list of reasons why emissions could not be computed, see ComputeFlightEmissions. This field uses wtw emissions aka ttw_emissions_grams_per_pax + wtt_emissions_grams_per_pax." }, "flight": { "$ref": "Flight", diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1.json index 7c0ed50f0f..684990e65e 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1.json @@ -2220,7 +2220,7 @@ } } }, -"revision": "20240912", +"revision": "20241013", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2430,6 +2430,21 @@ "description": "Represent the source AWS VM details.", "id": "AwsSourceVmDetails", "properties": { +"architecture": { +"description": "Output only. The VM architecture.", +"enum": [ +"VM_ARCHITECTURE_UNSPECIFIED", +"VM_ARCHITECTURE_X86_FAMILY", +"VM_ARCHITECTURE_ARM64" +], +"enumDescriptions": [ +"The architecture is unknown.", +"The architecture is one of the x86 architectures.", +"The architecture is ARM64." +], +"readOnly": true, +"type": "string" +}, "committedStorageBytes": { "description": "Output only. The total size of the disks being migrated in bytes.", "format": "int64", @@ -2700,6 +2715,21 @@ "description": "Represent the source Azure VM details.", "id": "AzureSourceVmDetails", "properties": { +"architecture": { +"description": "Output only. The VM architecture.", +"enum": [ +"VM_ARCHITECTURE_UNSPECIFIED", +"VM_ARCHITECTURE_X86_FAMILY", +"VM_ARCHITECTURE_ARM64" +], +"enumDescriptions": [ +"The architecture is unknown.", +"The architecture is one of the x86 architectures.", +"The architecture is ARM64." +], +"readOnly": true, +"type": "string" +}, "committedStorageBytes": { "description": "Output only. The total size of the disks being migrated in bytes.", "format": "int64", @@ -2741,6 +2771,20 @@ "description": "AzureVmDetails describes a VM in Azure.", "id": "AzureVmDetails", "properties": { +"architecture": { +"description": "The CPU architecture.", +"enum": [ +"VM_ARCHITECTURE_UNSPECIFIED", +"VM_ARCHITECTURE_X86_FAMILY", +"VM_ARCHITECTURE_ARM64" +], +"enumDescriptions": [ +"The architecture is unknown.", +"The architecture is one of the x86 architectures.", +"The architecture is ARM64." +], +"type": "string" +}, "bootOption": { "description": "The VM Boot Option.", "enum": [ @@ -5899,6 +5943,21 @@ "description": "Represent the source Vmware VM details.", "id": "VmwareSourceVmDetails", "properties": { +"architecture": { +"description": "Output only. The VM architecture.", +"enum": [ +"VM_ARCHITECTURE_UNSPECIFIED", +"VM_ARCHITECTURE_X86_FAMILY", +"VM_ARCHITECTURE_ARM64" +], +"enumDescriptions": [ +"The architecture is unknown.", +"The architecture is one of the x86 architectures.", +"The architecture is ARM64." +], +"readOnly": true, +"type": "string" +}, "committedStorageBytes": { "description": "Output only. The total size of the disks being migrated in bytes.", "format": "int64", @@ -5940,6 +5999,21 @@ "description": "VmwareVmDetails describes a VM in vCenter.", "id": "VmwareVmDetails", "properties": { +"architecture": { +"description": "Output only. The CPU architecture.", +"enum": [ +"VM_ARCHITECTURE_UNSPECIFIED", +"VM_ARCHITECTURE_X86_FAMILY", +"VM_ARCHITECTURE_ARM64" +], +"enumDescriptions": [ +"The architecture is unknown.", +"The architecture is one of the x86 architectures.", +"The architecture is ARM64." +], +"readOnly": true, +"type": "string" +}, "bootOption": { "description": "Output only. The VM Boot Option.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json index b41244248a..1b49303e19 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json @@ -2220,7 +2220,7 @@ } } }, -"revision": "20240912", +"revision": "20241013", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2430,6 +2430,21 @@ "description": "Represent the source AWS VM details.", "id": "AwsSourceVmDetails", "properties": { +"architecture": { +"description": "Output only. The VM architecture.", +"enum": [ +"VM_ARCHITECTURE_UNSPECIFIED", +"VM_ARCHITECTURE_X86_FAMILY", +"VM_ARCHITECTURE_ARM64" +], +"enumDescriptions": [ +"The architecture is unknown.", +"The architecture is one of the x86 architectures.", +"The architecture is ARM64." +], +"readOnly": true, +"type": "string" +}, "committedStorageBytes": { "description": "Output only. The total size of the disks being migrated in bytes.", "format": "int64", @@ -2700,6 +2715,21 @@ "description": "Represent the source Azure VM details.", "id": "AzureSourceVmDetails", "properties": { +"architecture": { +"description": "Output only. The VM architecture.", +"enum": [ +"VM_ARCHITECTURE_UNSPECIFIED", +"VM_ARCHITECTURE_X86_FAMILY", +"VM_ARCHITECTURE_ARM64" +], +"enumDescriptions": [ +"The architecture is unknown.", +"The architecture is one of the x86 architectures.", +"The architecture is ARM64." +], +"readOnly": true, +"type": "string" +}, "committedStorageBytes": { "description": "Output only. The total size of the disks being migrated in bytes.", "format": "int64", @@ -2741,6 +2771,20 @@ "description": "AzureVmDetails describes a VM in Azure.", "id": "AzureVmDetails", "properties": { +"architecture": { +"description": "The CPU architecture.", +"enum": [ +"VM_ARCHITECTURE_UNSPECIFIED", +"VM_ARCHITECTURE_X86_FAMILY", +"VM_ARCHITECTURE_ARM64" +], +"enumDescriptions": [ +"The architecture is unknown.", +"The architecture is one of the x86 architectures.", +"The architecture is ARM64." +], +"type": "string" +}, "bootOption": { "description": "The VM Boot Option.", "enum": [ @@ -6153,6 +6197,21 @@ "description": "Represent the source Vmware VM details.", "id": "VmwareSourceVmDetails", "properties": { +"architecture": { +"description": "Output only. The VM architecture.", +"enum": [ +"VM_ARCHITECTURE_UNSPECIFIED", +"VM_ARCHITECTURE_X86_FAMILY", +"VM_ARCHITECTURE_ARM64" +], +"enumDescriptions": [ +"The architecture is unknown.", +"The architecture is one of the x86 architectures.", +"The architecture is ARM64." +], +"readOnly": true, +"type": "string" +}, "committedStorageBytes": { "description": "Output only. The total size of the disks being migrated in bytes.", "format": "int64", @@ -6194,6 +6253,21 @@ "description": "VmwareVmDetails describes a VM in vCenter.", "id": "VmwareVmDetails", "properties": { +"architecture": { +"description": "Output only. The CPU architecture.", +"enum": [ +"VM_ARCHITECTURE_UNSPECIFIED", +"VM_ARCHITECTURE_X86_FAMILY", +"VM_ARCHITECTURE_ARM64" +], +"enumDescriptions": [ +"The architecture is unknown.", +"The architecture is one of the x86 architectures.", +"The architecture is ARM64." +], +"readOnly": true, +"type": "string" +}, "bootOption": { "description": "Output only. The VM Boot Option.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/vmwareengine.v1.json b/googleapiclient/discovery_cache/documents/vmwareengine.v1.json index 8567acf51a..324ec69647 100644 --- a/googleapiclient/discovery_cache/documents/vmwareengine.v1.json +++ b/googleapiclient/discovery_cache/documents/vmwareengine.v1.json @@ -413,7 +413,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/networkPeerings/my-peering`", +"description": "Output only. Identifier. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/networkPeerings/my-peering`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/networkPeerings/[^/]+$", "required": true, @@ -678,7 +678,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of this network policy. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy`", +"description": "Output only. Identifier. The resource name of this network policy. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/networkPolicies/[^/]+$", "required": true, @@ -1281,7 +1281,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`", +"description": "Output only. Identifier. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$", "required": true, @@ -1515,7 +1515,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of this DNS profile. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/dnsForwarding`", +"description": "Output only. Identifier. The resource name of this DNS profile. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/dnsForwarding`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/dnsForwarding$", "required": true, @@ -1733,7 +1733,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`", +"description": "Output only. Identifier. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/clusters/[^/]+$", "required": true, @@ -2043,7 +2043,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of this external IP address. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address`", +"description": "Output only. Identifier. The resource name of this external IP address. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/externalAddresses/[^/]+$", "required": true, @@ -2729,7 +2729,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet`", +"description": "Output only. Identifier. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/subnets/[^/]+$", "required": true, @@ -3137,7 +3137,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network`", +"description": "Output only. Identifier. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/vmwareEngineNetworks/[^/]+$", "required": true, @@ -3173,7 +3173,7 @@ } } }, -"revision": "20240701", +"revision": "20241009", "rootUrl": "https://vmwareengine.googleapis.com/", "schemas": { "AuditConfig": { @@ -3327,7 +3327,7 @@ "type": "boolean" }, "name": { -"description": "Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`", +"description": "Output only. Identifier. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`", "readOnly": true, "type": "string" }, @@ -3430,7 +3430,7 @@ "type": "array" }, "name": { -"description": "Output only. The resource name of this DNS profile. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/dnsForwarding`", +"description": "Output only. Identifier. The resource name of this DNS profile. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/dnsForwarding`", "readOnly": true, "type": "string" }, @@ -3599,7 +3599,7 @@ "type": "string" }, "name": { -"description": "Output only. The resource name of this external IP address. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address`", +"description": "Output only. Identifier. The resource name of this external IP address. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address`", "readOnly": true, "type": "string" }, @@ -4481,7 +4481,7 @@ "type": "boolean" }, "name": { -"description": "Output only. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/networkPeerings/my-peering`", +"description": "Output only. Identifier. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/networkPeerings/my-peering`", "readOnly": true, "type": "string" }, @@ -4587,7 +4587,7 @@ "description": "Network service that allows VMware workloads to access the internet." }, "name": { -"description": "Output only. The resource name of this network policy. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy`", +"description": "Output only. Identifier. The resource name of this network policy. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy`", "readOnly": true, "type": "string" }, @@ -5065,7 +5065,7 @@ "description": "Required. Input only. The management cluster for this private cloud. This field is required during creation of the private cloud to provide details for the default cluster. The following fields can't be changed after private cloud creation: `ManagementCluster.clusterId`, `ManagementCluster.nodeTypeId`." }, "name": { -"description": "Output only. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`", +"description": "Output only. Identifier. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`", "readOnly": true, "type": "string" }, @@ -5378,7 +5378,7 @@ "type": "string" }, "name": { -"description": "Output only. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet`", +"description": "Output only. Identifier. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet`", "readOnly": true, "type": "string" }, @@ -5528,7 +5528,7 @@ "type": "string" }, "name": { -"description": "Output only. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network`", +"description": "Output only. Identifier. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network`", "readOnly": true, "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/walletobjects.v1.json b/googleapiclient/discovery_cache/documents/walletobjects.v1.json index 2ff462359e..41d908adc3 100644 --- a/googleapiclient/discovery_cache/documents/walletobjects.v1.json +++ b/googleapiclient/discovery_cache/documents/walletobjects.v1.json @@ -2681,7 +2681,7 @@ } } }, -"revision": "20240927", +"revision": "20241024", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { @@ -3955,6 +3955,18 @@ true ], "type": "string" }, +"notifyPreference": { +"description": "Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.", +"enum": [ +"NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED", +"NOTIFY_ON_UPDATE" +], +"enumDescriptions": [ +"Default behavior is no notifications sent.", +"This value will result in a notification being sent, if the updated fields are part of an allowlist." +], +"type": "string" +}, "redemptionIssuers": { "description": "Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.", "items": { @@ -4248,6 +4260,18 @@ true }, "type": "array" }, +"notifyPreference": { +"description": "Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.", +"enum": [ +"NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED", +"NOTIFY_ON_UPDATE" +], +"enumDescriptions": [ +"Default behavior is no notifications sent.", +"This value will result in a notification being sent, if the updated fields are part of an allowlist." +], +"type": "string" +}, "passConstraints": { "$ref": "PassConstraints", "description": "Pass constraints for the object. Includes limiting NFC and screenshot behaviors." @@ -4762,6 +4786,18 @@ true ], "type": "string" }, +"notifyPreference": { +"description": "Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.", +"enum": [ +"NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED", +"NOTIFY_ON_UPDATE" +], +"enumDescriptions": [ +"Default behavior is no notifications sent.", +"This value will result in a notification being sent, if the updated fields are part of an allowlist." +], +"type": "string" +}, "origin": { "$ref": "AirportInfo", "description": "Required. Origin airport." @@ -5012,6 +5048,18 @@ true }, "type": "array" }, +"notifyPreference": { +"description": "Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.", +"enum": [ +"NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED", +"NOTIFY_ON_UPDATE" +], +"enumDescriptions": [ +"Default behavior is no notifications sent.", +"This value will result in a notification being sent, if the updated fields are part of an allowlist." +], +"type": "string" +}, "passConstraints": { "$ref": "PassConstraints", "description": "Pass constraints for the object. Includes limiting NFC and screenshot behaviors." @@ -5330,6 +5378,7 @@ true "GENERIC_HOME_INSURANCE", "GENERIC_ENTRY_TICKET", "GENERIC_RECEIPT", +"GENERIC_LOYALTY_CARD", "GENERIC_OTHER" ], "enumDescriptions": [ @@ -5345,6 +5394,7 @@ true "Home-insurance cards", "Entry tickets", "Receipts", +"Loyalty cards. Please note that it is advisable to use a dedicated Loyalty card pass type instead of this generic type. A dedicated loyalty card pass type offers more features and functionality than a generic pass type.", "Other type" ], "type": "string" @@ -5668,6 +5718,18 @@ true ], "type": "string" }, +"notifyPreference": { +"description": "Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.", +"enum": [ +"NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED", +"NOTIFY_ON_UPDATE" +], +"enumDescriptions": [ +"Default behavior is no notifications sent.", +"This value will result in a notification being sent, if the updated fields are part of an allowlist." +], +"type": "string" +}, "pinLabel": { "description": "The label to display for the PIN, such as \"4-digit PIN\".", "type": "string" @@ -5903,6 +5965,18 @@ true }, "type": "array" }, +"notifyPreference": { +"description": "Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.", +"enum": [ +"NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED", +"NOTIFY_ON_UPDATE" +], +"enumDescriptions": [ +"Default behavior is no notifications sent.", +"This value will result in a notification being sent, if the updated fields are part of an allowlist." +], +"type": "string" +}, "passConstraints": { "$ref": "PassConstraints", "description": "Pass constraints for the object. Includes limiting NFC and screenshot behaviors." @@ -6504,6 +6578,18 @@ true ], "type": "string" }, +"notifyPreference": { +"description": "Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.", +"enum": [ +"NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED", +"NOTIFY_ON_UPDATE" +], +"enumDescriptions": [ +"Default behavior is no notifications sent.", +"This value will result in a notification being sent, if the updated fields are part of an allowlist." +], +"type": "string" +}, "programLogo": { "$ref": "Image", "description": "Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app." @@ -6758,6 +6844,18 @@ true }, "type": "array" }, +"notifyPreference": { +"description": "Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.", +"enum": [ +"NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED", +"NOTIFY_ON_UPDATE" +], +"enumDescriptions": [ +"Default behavior is no notifications sent.", +"This value will result in a notification being sent, if the updated fields are part of an allowlist." +], +"type": "string" +}, "passConstraints": { "$ref": "PassConstraints", "description": "Pass constraints for the object. Includes limiting NFC and screenshot behaviors." @@ -7458,6 +7556,18 @@ true ], "type": "string" }, +"notifyPreference": { +"description": "Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.", +"enum": [ +"NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED", +"NOTIFY_ON_UPDATE" +], +"enumDescriptions": [ +"Default behavior is no notifications sent.", +"This value will result in a notification being sent, if the updated fields are part of an allowlist." +], +"type": "string" +}, "provider": { "description": "Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens.", "type": "string" @@ -7721,6 +7831,18 @@ true }, "type": "array" }, +"notifyPreference": { +"description": "Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.", +"enum": [ +"NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED", +"NOTIFY_ON_UPDATE" +], +"enumDescriptions": [ +"Default behavior is no notifications sent.", +"This value will result in a notification being sent, if the updated fields are part of an allowlist." +], +"type": "string" +}, "passConstraints": { "$ref": "PassConstraints", "description": "Pass constraints for the object. Includes limiting NFC and screenshot behaviors." @@ -8849,6 +8971,18 @@ true ], "type": "string" }, +"notifyPreference": { +"description": "Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.", +"enum": [ +"NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED", +"NOTIFY_ON_UPDATE" +], +"enumDescriptions": [ +"Default behavior is no notifications sent.", +"This value will result in a notification being sent, if the updated fields are part of an allowlist." +], +"type": "string" +}, "redemptionIssuers": { "description": "Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.", "items": { @@ -9157,6 +9291,18 @@ true }, "type": "array" }, +"notifyPreference": { +"description": "Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.", +"enum": [ +"NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED", +"NOTIFY_ON_UPDATE" +], +"enumDescriptions": [ +"Default behavior is no notifications sent.", +"This value will result in a notification being sent, if the updated fields are part of an allowlist." +], +"type": "string" +}, "passConstraints": { "$ref": "PassConstraints", "description": "Pass constraints for the object. Includes limiting NFC and screenshot behaviors." diff --git a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json index 247f7b9cd2..9fa7145f75 100644 --- a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json @@ -772,7 +772,7 @@ } } }, -"revision": "20241002", +"revision": "20241016", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "AgentCommand": { @@ -793,42 +793,6 @@ }, "type": "object" }, -"AssetLocation": { -"description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", -"id": "AssetLocation", -"properties": { -"ccfeRmsPath": { -"description": "Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata.", -"type": "string" -}, -"expected": { -"$ref": "IsolationExpectations", -"description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." -}, -"extraParameters": { -"description": "Defines extra parameters required for specific asset types.", -"items": { -"$ref": "ExtraParameter" -}, -"type": "array" -}, -"locationData": { -"description": "Contains all kinds of physical location definitions for this asset.", -"items": { -"$ref": "LocationData" -}, -"type": "array" -}, -"parentAsset": { -"description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.", -"items": { -"$ref": "CloudAsset" -}, -"type": "array" -} -}, -"type": "object" -}, "BigQueryDestination": { "description": "Message describing big query destination", "id": "BigQueryDestination", @@ -844,49 +808,12 @@ }, "type": "object" }, -"BlobstoreLocation": { -"description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", -"id": "BlobstoreLocation", -"properties": { -"policyId": { -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", "properties": {}, "type": "object" }, -"CloudAsset": { -"id": "CloudAsset", -"properties": { -"assetName": { -"type": "string" -}, -"assetType": { -"type": "string" -} -}, -"type": "object" -}, -"CloudAssetComposition": { -"id": "CloudAssetComposition", -"properties": { -"childAsset": { -"items": { -"$ref": "CloudAsset" -}, -"type": "array" -} -}, -"type": "object" -}, "Command": { "description": "* Command specifies the type of command to execute.", "id": "Command", @@ -902,18 +829,6 @@ }, "type": "object" }, -"DirectLocationAssignment": { -"id": "DirectLocationAssignment", -"properties": { -"location": { -"items": { -"$ref": "LocationAssignment" -}, -"type": "array" -} -}, -"type": "object" -}, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -1029,6 +944,22 @@ "description": "The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}", "type": "string" }, +"notices": { +"description": "Output only. Additional information generated by the execution", +"items": { +"$ref": "Notice" +}, +"readOnly": true, +"type": "array" +}, +"ruleResults": { +"description": "Output only. execution result summary per rule", +"items": { +"$ref": "RuleExecutionResult" +}, +"readOnly": true, +"type": "array" +}, "runType": { "description": "type represent whether the execution executed directly by user or scheduled according evaluation.schedule field.", "enum": [ @@ -1152,17 +1083,6 @@ }, "type": "object" }, -"ExtraParameter": { -"description": "Defines parameters that should only be used for specific asset types.", -"id": "ExtraParameter", -"properties": { -"regionalMigDistributionPolicy": { -"$ref": "RegionalMigDistributionPolicy", -"description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." -} -}, -"type": "object" -}, "GceInstanceFilter": { "description": "Message describing compute engine instance filter", "id": "GceInstanceFilter", @@ -1206,131 +1126,6 @@ }, "type": "object" }, -"IsolationExpectations": { -"id": "IsolationExpectations", -"properties": { -"requirementOverride": { -"$ref": "RequirementOverride", -"description": "Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic." -}, -"ziOrgPolicy": { -"enum": [ -"ZI_UNSPECIFIED", -"ZI_UNKNOWN", -"ZI_NOT_REQUIRED", -"ZI_PREFERRED", -"ZI_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"ziRegionPolicy": { -"enum": [ -"ZI_REGION_POLICY_UNSPECIFIED", -"ZI_REGION_POLICY_UNKNOWN", -"ZI_REGION_POLICY_NOT_SET", -"ZI_REGION_POLICY_FAIL_OPEN", -"ZI_REGION_POLICY_FAIL_CLOSED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"ziRegionState": { -"enum": [ -"ZI_REGION_UNSPECIFIED", -"ZI_REGION_UNKNOWN", -"ZI_REGION_NOT_ENABLED", -"ZI_REGION_ENABLED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -}, -"zoneIsolation": { -"deprecated": true, -"description": "Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location.", -"enum": [ -"ZI_UNSPECIFIED", -"ZI_UNKNOWN", -"ZI_NOT_REQUIRED", -"ZI_PREFERRED", -"ZI_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"zoneSeparation": { -"deprecated": true, -"description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.", -"enum": [ -"ZS_UNSPECIFIED", -"ZS_UNKNOWN", -"ZS_NOT_REQUIRED", -"ZS_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -}, -"zsOrgPolicy": { -"enum": [ -"ZS_UNSPECIFIED", -"ZS_UNKNOWN", -"ZS_NOT_REQUIRED", -"ZS_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -}, -"zsRegionState": { -"enum": [ -"ZS_REGION_UNSPECIFIED", -"ZS_REGION_UNKNOWN", -"ZS_REGION_NOT_ENABLED", -"ZS_REGION_ENABLED" -], -"enumDescriptions": [ -"", -"To be used if tracking of the asset ZS-bit is not available", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, "ListEvaluationsResponse": { "description": "Message for response to listing Evaluations", "id": "ListEvaluationsResponse", @@ -1505,64 +1300,18 @@ }, "type": "object" }, -"LocationAssignment": { -"id": "LocationAssignment", +"Notice": { +"description": "Message for additional information generated by the execution", +"id": "Notice", "properties": { -"location": { -"type": "string" -}, -"locationType": { -"enum": [ -"UNSPECIFIED", -"CLUSTER", -"POP", -"CLOUD_ZONE", -"CLOUD_REGION", -"MULTI_REGION_GEO", -"MULTI_REGION_JURISDICTION", -"GLOBAL", -"OTHER" -], -"enumDescriptions": [ -"", -"1-10: Physical failure domains.", -"", -"11-20: Logical failure domains.", -"", -"", -"", -"", -"" -], +"message": { +"description": "Output only. Message of the notice", +"readOnly": true, "type": "string" } }, "type": "object" }, -"LocationData": { -"id": "LocationData", -"properties": { -"blobstoreLocation": { -"$ref": "BlobstoreLocation" -}, -"childAssetLocation": { -"$ref": "CloudAssetComposition" -}, -"directLocation": { -"$ref": "DirectLocationAssignment" -}, -"gcpProjectProxy": { -"$ref": "TenantProjectProxy" -}, -"placerLocation": { -"$ref": "PlacerLocation" -}, -"spannerLocation": { -"$ref": "SpannerLocation" -} -}, -"type": "object" -}, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -1642,74 +1391,6 @@ }, "type": "object" }, -"PlacerLocation": { -"description": "Message describing that the location of the customer resource is tied to placer allocations", -"id": "PlacerLocation", -"properties": { -"placerConfig": { -"description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")", -"type": "string" -} -}, -"type": "object" -}, -"RegionalMigDistributionPolicy": { -"description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", -"id": "RegionalMigDistributionPolicy", -"properties": { -"targetShape": { -"description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum", -"format": "int32", -"type": "integer" -}, -"zones": { -"description": "Cloud zones used by regional MIG to create instances.", -"items": { -"$ref": "ZoneConfiguration" -}, -"type": "array" -} -}, -"type": "object" -}, -"RequirementOverride": { -"id": "RequirementOverride", -"properties": { -"ziOverride": { -"enum": [ -"ZI_UNSPECIFIED", -"ZI_UNKNOWN", -"ZI_NOT_REQUIRED", -"ZI_PREFERRED", -"ZI_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"", -"" -], -"type": "string" -}, -"zsOverride": { -"enum": [ -"ZS_UNSPECIFIED", -"ZS_UNKNOWN", -"ZS_NOT_REQUIRED", -"ZS_REQUIRED" -], -"enumDescriptions": [ -"", -"To be used if tracking is not available", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, "Resource": { "description": "Message represent resource in execution result", "id": "Resource", @@ -1847,6 +1528,48 @@ }, "type": "object" }, +"RuleExecutionResult": { +"description": "Message for execution result summary per rule", +"id": "RuleExecutionResult", +"properties": { +"message": { +"description": "Execution message, if any", +"type": "string" +}, +"resultCount": { +"description": "Number of violations", +"format": "int64", +"type": "string" +}, +"rule": { +"description": "rule name", +"type": "string" +}, +"scannedResourceCount": { +"description": "Number of total scanned resources", +"format": "int64", +"type": "string" +}, +"state": { +"description": "Output only. The execution status", +"enum": [ +"STATE_UNSPECIFIED", +"STATE_SUCCESS", +"STATE_FAILURE", +"STATE_SKIPPED" +], +"enumDescriptions": [ +"Unknown state", +"execution completed successfully", +"execution completed with failures", +"execution was not executed" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "RunEvaluationRequest": { "description": "Message for creating a Execution", "id": "RunEvaluationRequest", @@ -2402,26 +2125,6 @@ }, "type": "object" }, -"SpannerLocation": { -"id": "SpannerLocation", -"properties": { -"backupName": { -"description": "Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata", -"items": { -"type": "string" -}, -"type": "array" -}, -"dbName": { -"description": "Set of databases used by the resource in format /span//", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "SqlserverValidation": { "description": "A presentation of SQLServer workload insight. The schema of SqlServer workloads validation related data.", "id": "SqlserverValidation", @@ -2537,18 +2240,6 @@ }, "type": "object" }, -"TenantProjectProxy": { -"id": "TenantProjectProxy", -"properties": { -"projectNumbers": { -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "ViolationDetails": { "description": "Message describing the violation in an evaluation result.", "id": "ViolationDetails", @@ -2595,15 +2286,6 @@ "id": "WriteInsightResponse", "properties": {}, "type": "object" -}, -"ZoneConfiguration": { -"id": "ZoneConfiguration", -"properties": { -"zone": { -"type": "string" -} -}, -"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/workstations.v1.json b/googleapiclient/discovery_cache/documents/workstations.v1.json index b5e39851d2..6779d0c10d 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1.json @@ -1195,7 +1195,7 @@ } } }, -"revision": "20240904", +"revision": "20241009", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1284,6 +1284,42 @@ }, "type": "object" }, +"BoostConfig": { +"description": "A configuration that workstations can boost to.", +"id": "BoostConfig", +"properties": { +"accelerators": { +"description": "Optional. A list of the type and count of accelerator cards attached to the boost instance. Defaults to `none`.", +"items": { +"$ref": "Accelerator" +}, +"type": "array" +}, +"bootDiskSizeGb": { +"description": "Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB.", +"format": "int32", +"type": "integer" +}, +"enableNestedVirtualization": { +"description": "Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series.", +"type": "boolean" +}, +"id": { +"description": "Optional. Required. The id to be used for the boost configuration.", +"type": "string" +}, +"machineType": { +"description": "Optional. The type of machine that boosted VM instances will use\u2014for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`.", +"type": "string" +}, +"poolSize": { +"description": "Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -1417,6 +1453,13 @@ }, "type": "array" }, +"boostConfigs": { +"description": "Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use.", +"items": { +"$ref": "BoostConfig" +}, +"type": "array" +}, "bootDiskSizeGb": { "description": "Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB.", "format": "int32", @@ -2286,6 +2329,13 @@ "description": "Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.", "type": "string" }, +"tags": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", +"type": "object" +}, "uid": { "description": "Output only. A system-assigned unique identifier for this workstation cluster.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/workstations.v1beta.json b/googleapiclient/discovery_cache/documents/workstations.v1beta.json index 06114e0511..0ddce66dd9 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1beta.json @@ -1127,7 +1127,7 @@ } } }, -"revision": "20240904", +"revision": "20241009", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -2268,6 +2268,13 @@ "description": "Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.", "type": "string" }, +"tags": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", +"type": "object" +}, "uid": { "description": "Output only. A system-assigned unique identifier for this workstation cluster.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/youtube.v3.json b/googleapiclient/discovery_cache/documents/youtube.v3.json index 15e3f55bf4..e4d36e3a61 100644 --- a/googleapiclient/discovery_cache/documents/youtube.v3.json +++ b/googleapiclient/discovery_cache/documents/youtube.v3.json @@ -4133,7 +4133,7 @@ } } }, -"revision": "20241010", +"revision": "20241022", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { @@ -8118,7 +8118,7 @@ true "type": "object" }, "InvideoBranding": { -"description": "LINT.IfChange Describes an invideo branding.", +"description": "Describes an invideo branding.", "id": "InvideoBranding", "properties": { "imageBytes": { @@ -8132,6 +8132,7 @@ true }, "position": { "$ref": "InvideoPosition", +"deprecated": true, "description": "The spatial position within the video where the branding watermark will be displayed." }, "targetChannelId": { @@ -10823,6 +10824,10 @@ true "TestItem": { "id": "TestItem", "properties": { +"etag": { +"description": "Etag for the resource. See https://en.wikipedia.org/wiki/HTTP_ETag.", +"type": "string" +}, "featuredPart": { "type": "boolean" },